people

People records represent an instance of a person and has attributes of Personal Details. An Employment record will reference a Person record and over time a person record may have one or more employment records attached to it

Get People

SecuritybearerAuth

Responses

200

People Response - Array

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

get/people

Request samples

curl
C#
Java
PHP

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people"
},
"data": [{"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"nationality": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/nationality",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/nationality"
}
},
"maritalCivilStatus": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/maritalcivilstatus",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/maritalcivilstatus"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
]
}

Create a New Person

SecuritybearerAuth

Request

Request Body schema: application/vnd.api+json

Person to be added. firstName and surname are required.

Important Address Block Constraint: When providing ANY address field (addressLine1-4, addressPostcode, or addressCountry), you MUST provide ALL address fields (addressLine1, addressLine2, addressLine3, addressLine4, addressPostcode). At least 2 address lines must contain actual content. Use empty strings for unused address lines.

object

Responses

200

People Response

400

Bad Request

401

Unauthorized - Authorization Required

422

Unprocessable Entity

default

General Error

post/people

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"0": null,
"nationality": {"data": {"id": "1",
"type": "nationalities"
}
},
"maritalCivilStatus": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "maritalCivilStatuses"
}
}
}
}
}

Response samples

200
400
401
422
default

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"nationality": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/nationality",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/nationality"
}
},
"maritalCivilStatus": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/maritalcivilstatus",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/maritalcivilstatus"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

Get Person by ID

Get Person by ID (Cintra Person ID)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Person ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Responses

200

People Response

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

get/people/{id}

Request samples

curl
C#
Java
PHP

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"nationality": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/nationality",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/nationality"
}
},
"maritalCivilStatus": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/maritalcivilstatus",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/maritalcivilstatus"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

Update an Existing Person

Update an existing person by ID (Cintra Person ID)

SecuritybearerAuth

Request

path Parameters

required

string <guid>

Person ID

Example: 906264f1-2dff-4f72-a10b-59918cf738d7

Request Body schema: application/vnd.api+json

Person object for partial update. Only the fields provided will be updated. No fields are required for PATCH operations.

object

Responses

200

People Response

400

Bad Request

401

Unauthorized - Authorization Required

404

Not Found

422

Unprocessable Entity

default

General Error

patch/people/{id}

Request samples

Payload
curl
C#
Java
PHP

application/vnd.api+json

{"data": {"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"0": null,
"nationality": {"data": {"id": "1",
"type": "nationalities"
}
},
"maritalCivilStatus": {"data": {"id": "4b30b724-26e1-4fcb-90f0-92936523133c",
"type": "maritalCivilStatuses"
}
}
},
"id": "906264f1-2dff-4f72-a10b-59918cf738d7"
}
}

Response samples

application/vnd.api+json

{"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people"
},
"data": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03",
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"knownAs": "Johnny",
"gender": "Male",
"dateOfBirth": "1990-01-15",
"niNumber": "AB123456C",
"maritalStatus": "Single",
"nationality": "British",
"intelliId": "12345-abcde-67890",
"dateOfDeath": "2020-12-31",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "john.doe@example.com",
"email2": "j.doe@personal.com",
"phoneNumber": "+44 20 7946 0958",
"mobileNumber": "+44 7700 900123"
},
"relationships": {"nationality": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/nationality",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/nationality"
}
},
"maritalCivilStatus": {"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/relationships/maritalcivilstatus",
"related": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03/maritalcivilstatus"
}
}
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}
}

➔ Next to positions