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",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"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

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",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"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": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "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": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "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 that needs to be updated (partial update)

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",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"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": {"0": {"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"type": "people",
"attributes": {"title": "Mr",
"firstName": "John",
"middleName": "Michael",
"surname": "Doe",
"gender": "Male",
"dateOfBirth": "2001-11-17",
"niNumber": "AA111111B",
"addressPostcode": "E11 1EE",
"addressLine1": "1 House",
"addressLine2": "Vanilla Street",
"addressLine3": "Eastern Sector",
"addressLine4": "London",
"addressCountry": "United Kingdom",
"email": "totallyvalid@cintra.co.uk",
"email2": "totallyvalid@cintra.co.uk",
"knownAs": "Abur",
"homeTelephone": "01111 111111",
"mobileTelephone": 44111111111
},
"links": {"self": "https://integrations.cintra.cloud/integrations/00000000-0000-0000-0000-000000000000/people/a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
},
"id": "a0bc1ba8-063e-c1fd-3e8f-6b5951f33e03"
}
}

➔ Next to positions