Actor API

https://actor.intelligencefusion.co.uk

The Actor API provides information about organisations and individuals.

GET /actor Get all actors

This endpoint gets all available actors. The actors returned can be filtered by adding search parameters to your request.

HTTP Request

curl -X GET 'https://actor.intelligencefusion.co.uk/actor' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  -d 'search=Rebellion' \
  -d 'sort=name_asc' \
  --compressed

Headers

Name Type Required Description
Authorization string ✔️ Your authentication token (see the Auth API section for more information)

Query Parameters

Name Type Description
search string (Optional) Search term to filter actors by.
type string (Optional) Filter actors by type. in:INDIVIDUAL in:GROUP
hasProfile boolean (Optional) Flag to filter actors with or without a profile.
limit integer (Optional) Maximum number of actors to return per page.
page integer (Optional) Page number of results to retrieve.
sort string (Optional) Field to sort results by.

HTTP Response

{
    "status": "success",
    "data": {
        "actors": [
            {
                "id": "9cd667d3-27f6-45b9-9e13-8470fe343b37",
                "name": "Animal Rebellion",
                "type": "GROUP",
                "status": "APPROVED",
                "profile": "Animal Rebellion is an animal and climate justice movement with the stated aim of using nonviolent civil disobedience to compel government action towards a plant-based food system. The group conducts direct action protest and attempts to cause disruption in order to highlight their cause.",
                "createdAt": 1622130242,
                "updatedAt": 1622130242
            },
            {
                "id": "79e4fcfc-4d2b-4569-a3e7-ebda14d0d7b7",
                "name": "Extinction Rebellion",
                "type": "GROUP",
                "status": "APPROVED",
                "profile": "Extinction Rebellion is a global environmental movement with the stated aim of using nonviolent civil disobedience to compel government action to avoid tipping points in the climate system, biodiversity loss, and the risk of social and ecological collapse.",
                "createdAt": 1622130240,
                "updatedAt": 1622130240
            },
            {
                "id": "a49a3af9-3753-444c-b82e-446256d62dd3",
                "name": "Ocean Rebellion",
                "type": "GROUP",
                "status": "APPROVED",
                "profile": "The group is linked to Extinction Rebellion and campaigns against the cruise industry and ocean pollution. The group uses similar direct action methods as Extinction rebellion such as guerilla media advertising.",
                "createdAt": 1622130240,
                "updatedAt": 1622130240
            }
        ],
        "meta": {
            "total": 3,
            "page": 1,
            "pages": 1,
            "pageSize": 100
        }
    }
}

Success

Code Status Description
200 Success Returns a body containing all valid actors

Errors

Code Status Description
401 Unauthorized Expired or Invalid Authentication token
400 Bad Request Invalid query parameters
422 Unprocessable Entity Incorrect or invalid search parameter

GET /actor/{{ID}} Get actor by ID

This endpoint gets a requested individual.

HTTP Request

curl -X GET 'https://actor.intelligencefusion.co.uk/actor/{{ID}}' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  --compressed

Headers

Name Type Required Description
Authorization string ✔️ Your authentication token (see the Auth API section for more information)

HTTP Response

{
    "status": "success",
    "data": {
        "actor": {
            "id": "9cd667d3-27f6-45b9-9e13-8470fe343b37",
            "name": "Animal Rebellion",
            "type": "GROUP",
            "status": "APPROVED",
            "profile": "Animal Rebellion is an animal and climate justice movement with the stated aim of using nonviolent civil disobedience to compel government action towards a plant-based food system. The group conducts direct action protest and attempts to cause disruption in order to highlight their cause.",
            "createdAt": 1622130242,
            "updatedAt": 1622130242
        }
    }
}

Success

Code Status Description
200 Success Returns a body with an actors details

Errors

Code Status Description
401 Unauthorized Expired or Invalid Authentication token
404 Not found Actor with specified ID does not exist