Retrieve a person
Get a person object by its ID. The function returns the decrypted, abridged person record.
Please use the Attributes API to retrieve custom person attributes.
Path Parameters
- person_id string required
The person ID
Example: 903c1ff9-f2cc-435c-b242-9d8a690fcf0a
Query Parameters
- fields string[]
Possible values: [
handles
,groups
,attributes
]Optional fields to include in the response
Header Parameters
- SlashID-OrgID string required
The organization ID
Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses
- 200
- 400
- 404
OK
- application/json
- Schema
- Example (from schema)
Schema
meta object
errors object[]
result object
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
],
"result": {
"active": true,
"person_id": "string",
"person_type": "regular",
"region": "us-iowa",
"handles": [
{
"type": "email_address",
"value": "string"
}
],
"groups": [
"string"
],
"attributes": {}
}
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
meta object
errors object[]
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
meta object
errors object[]
{
"meta": {
"pagination": {
"limit": 0,
"offset": 0,
"total_count": 0
}
},
"errors": [
{
"httpcode": 0,
"message": "string"
}
]
}
GET /persons/:person_id
https://api.slashid.com
Authorization
type: apiKeyname: SlashID-API-Keyin: header
Request
Request
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'
curl -L -X GET 'https://api.slashid.com/persons/:person_id' \
-H 'Accept: application/json' \
-H 'SlashID-OrgID: <SLASHID_ORG_ID_VALUE>' \
-H 'SlashID-API-Key: <API_KEY_VALUE>'