Get a persona
Retrieve one persona by its ID.
Returns one persona of the client's workspace. An archived persona, or one that belongs to another workspace, is reported as not found.
Route
GET/api/v3/partner/workspaces/{partner_workspace_id}/personas/{persona_id}
Path parameters
| Parameter | Type | Description |
|---|---|---|
| partner_workspace_id | string | Your own ID for the client workspace, as you chose it at creation. URL-encode it in the path. |
| persona_id | integer | ID of the persona, from List personas. |
Example request
curl "https://api.getsillage.com/api/v3/partner/workspaces/ws_123/personas/7" \
-H "Authorization: Bearer $SILLAGE_MASTER_KEY"Success response
Status: 200 OK
{
"data": {
"id": 7,
"name": "Sales EMEA persona",
"job_titles": ["VP Sales", "Head of Sales"],
"excluded_job_titles": ["Intern"],
"locations": ["United States", "France"],
"headcounts": ["51-200", "201-500"],
"industries": ["Software"],
"seniorities": ["vp", "head"],
"exclusion_criteria": ["Agencies"],
"tag": "smb-us"
}
}Response fields
| Field | Type | Description |
|---|---|---|
| data.id | integer | ID of the persona. |
| data.name | string | The persona's name, as shown in the app. |
| data.job_titles | array of string | Target job titles. [] when there are none. |
| data.excluded_job_titles | array of string | People whose LinkedIn headline contains one of these words won't become leads. |
| data.locations | array of string | Target locations: countries or regions. [] when there are none. |
| data.headcounts | array of string | Target headcount ranges. [] when there are none. |
| data.industries | array of string | Target industries. [] when there are none. |
| data.seniorities | array of string | The seniority levels this persona targets. |
| data.exclusion_criteria | array of string | Sentences or keywords describing who to leave out. |
| data.tag | string or null | The short label you set to recognise this persona. Never used for targeting, and unique across the personas of the workspace. |
Errors
| Status | Meaning |
|---|---|
| 401 | The master key is missing or invalid. |
| 404 | No workspace found for this partner_workspace_id, or the persona does not exist or is archived. |
| 422 | persona_id is not a valid ID. A query parameter is sent: this route takes none, and errors names the parameter. |
| 429 | Rate limit exceeded. |
| 500 | An unexpected server error occurred. |
Error responses use RFC 9457 problem documents with Content-Type: application/problem+json. type is always about:blank; code tells one problem from another, detail says what went wrong this time, and errors names the field at fault.