[GET] Get all actors

Modified on Tue, 11 Feb at 3:40 AM

https://actor.s7risk.com

The Actor API provides information about organisations and individuals

GET /actorGet 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.s7risk.com/actor' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {{YOUR_AUTHENTICATION_TOKEN}}' \
  -d 'search=Rebellion' \
  -d 'sort=name_asc' \
  --compressed

Headers

NameTypeRequiredDescription
Authorizationstring✔️Your authentication token (see the Auth API section for more information)

Query Parameters

NameTypeDescription
searchstring(Optional) Search term to filter actors by.
typestring(Optional) Filter actors by type. in:INDIVIDUAL in:GROUP
hasProfileboolean(Optional) Flag to filter actors with or without a profile.
limitinteger(Optional) Maximum number of actors to return per page.
pageinteger(Optional) Page number of results to retrieve.
sortstring(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

CodeStatusDescription
200SuccessReturns a body containing all valid actors

Errors

CodeStatusDescription
401UnauthorizedExpired or Invalid Authentication token
400Bad RequestInvalid query parameters
422Unprocessable EntityIncorrect or invalid search parameter

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

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article