List all authors

This API allows to get a list of all authors.

GET /authors

Try it

List all authors

cURL

curl --request GET \
  --url https://{your-workspace}.neetokb.com/api/external/v1/authors \
  --header 'X-Api-Key: <x-api-key>'

200

{
  "authors": [
    {
      "name": "<string>",
      "email": "[e-mail]",
      "profile_image_url": "<string>"
    }
  ],
  "pagination": {
    "total_records": 123,
    "total_pages": 123,
    "current_page_number": 123,
    "page_size": 123
  }
}

Replace {your-workspace} with your workspace’s subdomain.
Learn how to find your subdomain in Identifying your subdomain.

Headers

X-Api-Key · string · default: your-api-key · required

X-Api-Key is used to authenticate requests using an API key. Provide your API key in this header to access protected endpoints. Refer to Authentication for more information.

Query Parameters

page_number · integer

Retrieve paginated results by specifying the desired page number. Defaulting to 1 when omitted.

page_size · integer

Set the number of results returned in the response. Defaulting to 30 when omitted.

Response

200 - application/json

OK - Request succeeded

authors · object[]

Hide child attributes

authors. name · string

authors. email · string<email>

authors. profile_image_url · string<uri> | null

pagination · object

Hide child attributes

pagination. total_records · integer

pagination. total_pages · integer

pagination. current_page_number · integer

pagination. page_size · integer