Retrieve the flags currently applied to a person

Retrieve all flags currently applied to a person, ordered newest first.

Person flags differ from other entity flag endpoints (e.g. Purchase Orders, Sales Opportunities): a person can have multiple flags active simultaneously, there is no single "current" flag, and there is no separate history endpoint — this list is the complete current state.

The id values returned are flag type IDs scoped to the ContactUser entity type. Use GET /flags?entityType=ContactUser (requires the flags:read scope) to discover valid flag IDs for this customer. (required scope contacts:persons:read)

get/v1/persons/{personId}/flags

Path parameters

personIdstring uuid required

The unique identifier of the person

Query parameters

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

pageNumberinteger

pageSizeinteger

totalItemCountinteger

Example response

{
  "items": [
    {
      "id": 12345,
      "name": "Urgent",
      "description": "This flag indicates urgent items",
      "color": "#FF0000",
      "createdAt": "2022-11-29T16:50:16.0000000+00:00"
    }
  ]
}