getstarted.ae

List persons

GEThttps://api.getstarted.ae/v1/customers/{customerId}/persons

Lists the persons created under a customer.

Path parameters

  • customerIdstringrequired

    ID of the customer, e.g. cus_01J9ZK4R7Q2M8X.

Query parameters

  • limitinteger

    Page size, 1 to 100. Defaults to 25.

  • cursorstring

    The nextCursor value from the previous page.

Responses

  • 200OK. Returns the object shown in the example.
  • 404resource_not_found No customer with that ID exists in this environment.
  • Every endpoint can also return 401 for a missing or invalid key. See Errors.
curl -X GET "https://api.getstarted.ae/v1/customers/cus_01J9ZK4R7Q2M8X/persons" \
  -H "Authorization: Bearer $GETSTARTED_API_KEY"
Response · 200
{
  "object": "list",
  "data": [
    {
      "id": "per_01J9ZKA1M4HD2T",
      "object": "person",
      "customerId": "cus_01J9ZK4R7Q2M8X",
      "firstName": "Maya",
      "lastName": "Okafor",
      "dateOfBirth": "1989-04-17",
      "nationality": "GB",
      "email": "maya@northwindlabs.com",
      "phone": "+447700900123",
      "residentialAddress": {
        "line1": "42 Elm Street",
        "line2": null,
        "city": "London",
        "region": null,
        "postalCode": "N1 7GU",
        "country": "GB"
      },
      "createdAt": "2026-09-20T08:20:03Z",
      "updatedAt": "2026-09-20T08:20:03Z"
    }
  ],
  "hasMore": false,
  "nextCursor": null
}