Retrieve all people

This endpoint retrieves all people in your account. You can narrow down the data returned by filtering on the source of the person (see the section about creating people for more information).

HTTP Request

GET https://api.lunatask.app/v1/people

Query Parameters

Parameter	Description
source	The source specified when creating the person (optional)
source_id	The source_id specified when creating the person (optional)

If no source is specified, all people are returned.

Example in Ruby

require 'rest-client'

access_token = 'xxx'

RestClient.get('https://api.lunatask.app/v1/people', { Authorization: "bearer #{access_token}" })

Response

The request returns JSON structured like this:

{
  "people": [
    {
      "id": "5999b945-b2b1-48c6-aa72-b251b75b3c2e",
      "relationship_strength": "business-contacts",
      "sources": [
        {
          "source": "salesforce",
          "source_id": "352fd2d7-cdc0-4e91-a0a3-9d6cc9d440e7"
        }
      ],
      "created_at": "2021-01-10T10:39:25Z",
      "updated_at": "2021-01-10T10:39:25Z"
    },
    {
      "id": "109cbf01-dba9-4136-8cf1-a02084ba3977",
      "relationship_strength": "family",
      "sources": [],
      "created_at": "2021-01-10T10:39:25Z",
      "updated_at": "2021-01-10T10:39:25Z"
    }
  ]
}