Success responses

Codes in the 2xx range indicate that folk’s API accepted the request. Depending on the endpoint, the request is either performed right away (200) or accepted to be performed later (202). For 4xx and 5xx errors, see Errors responses.

Success response

The success response contains a single data property that holds the requested resource, or the page of resources for list endpoints.

{
  "data": {
    "id": "grp_5fa4a5e9-6c42-4b9c-a8a4-4a5f6ff3e5c1",
    "name": "Clients"
  }
}

Status codes

OK

Status code: 200
The request was performed right away. The response contains the result of the request: for instance, the resource that was retrieved, created, updated or deleted.

Accepted

Status code: 202
The request was accepted, and will be performed asynchronously. It isn’t done yet when the response is sent: the response contains the resource that follows the progress of the request, with a status and an ID. To get the result of the request, read the documentation of the endpoint you called: it tells you which endpoint to poll with the returned ID, or which webhook to subscribe to in order to be notified when the request is over. For instance, Enrich people returns a 202 response with a pending enrichment. Poll Get an enrichment of people with its ID until its status is completed or failed, or subscribe a webhook to the person_enrichment.finished event.

Introduction

Available endpoints