> ## Documentation Index > Fetch the complete documentation index at: https://www.1password.dev/llms.txt > Use this file to discover all available pages before exploring further. # Get a person > Fetches a single person by their SaaS Manager ID (a UUID) or by email address. If an email address matches more than one person a 409 Conflict is returned. **Required scope:** `People.Read` (Read-only access to people and teams) ## OpenAPI ````yaml /openapi/saas_manager_api.json get /api/people/v1/{id} openapi: 3.0.4 info: title: SaaS Manager API description: >- By accessing or using 1Password Developer Tools, you agree to the [API and SDK Terms of Service](https://1password.com/legal/api-sdk-terms-of-service). --- The SaaS Manager public REST API lets you read and manage your applications, people, teams, contracts, devices, workflows and audit log programmatically. Resources are grouped by area (see the navigation). The conventions below apply across the whole API. ## Regions and base URL SaaS Manager is hosted in multiple regions. Pick the base URL for your tenant's region from the **Servers** dropdown — `https://app.trelica.com` (United States) or `https://eu.trelica.com` (Europe). Endpoint URLs throughout this reference use whichever server you select. ## Authentication Every request must send an `Authorization` header carrying an OAuth 2.0 access token, prefixed with `Bearer`: ``` Authorization: Bearer ``` Obtain a token using either the **Client Credentials** flow (machine-to-machine) or the **Authorization Code** flow (acting on behalf of a user). The scopes granted to your token determine which endpoints you may call — see [Scopes](#scopes). Access tokens expire. When a token is missing, invalid or expired you receive `401 Unauthorized`; inspect the `WWW-Authenticate` response header for detail, for example: ``` Bearer error="invalid_token", error_description="The token expired at '12/23/2020 10:27:15'" ``` If you used the Authorization Code flow with the `offline_access` scope, use your refresh token to obtain a new access token. A `403 Forbidden` means the token is valid but lacks the scope required by the endpoint. ## Dates and times Dates and date/times are sent and returned in [RFC 3339](https://tools.ietf.org/html/rfc3339) format (essentially ISO 8601), for example `2020-12-25` (midnight) or `2020-12-25T10:50:00Z`. Field names ending in `Dtm` carry a meaningful time component; field names ending in `Date` are date-only. ## Optional fields and null Responses omit fields that have no value — you will see the field absent rather than returned as `null`. When creating or replacing a resource (`PUT`), any field you omit is cleared. With `PATCH`, omitting a field leaves it unchanged, whereas sending it as `null` clears it. ## Pagination List endpoints are paginated and return at most 100 results by default. Request a different upper bound with the `limit` query parameter (maximum 1000) — you may receive fewer than requested. Request the next page with the `after` query parameter, passing the opaque cursor token that SaaS Manager supplies. The response's `next` field (and the `link` response header, `rel="next"`) contains the full URL for the next page: ```json { "next": "https://app.trelica.com/api/people/v1?after=&limit=100", "results": [ { /* ... */ } ] } ``` Keep requesting pages until no further results are returned. (User data exposed over SCIM uses the SCIM `startIndex`/`count` pagination scheme instead.) ## Filtering Many list endpoints accept a `filter` query parameter (URL-encoded) based on the [SCIM filtering specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2). A filter is one or more expressions — an attribute name, an operator, and an optional value — combined with `and`, `or`, `not`, and grouped with parentheses. Attribute names match the JSON returned and may use dot notation for nested attributes (e.g. `createdBy.email`). For an attribute that is an **array of objects**, put a sub-expression in brackets — the item matches when *any* element satisfies it: `teams[name eq "Developers"]` or `teams[id eq "5f8d0a1b2c3d4e5f60718293"]`. Values are strings (double-quoted), integers, dates (double-quoted, RFC 3339) or booleans. Some list endpoints also accept a free-text `q` parameter that searches the resource's displayable fields. Soft-deleted entities are excluded by default; include them with a filter that references `deleted` (e.g. `filter=deleted eq true`). | Operator | Meaning | Behaviour | |----------|---------|-----------| | `eq` | equal | Attribute value is identical to the operator value | | `ne` | not equal | Attribute value differs from the operator value | | `co` | contains | Attribute value contains the operator value text | | `sw` | starts with | Attribute value starts with the operator value text | | `ew` | ends with | Attribute value ends with the operator value text | | `pr` | present | Attribute has a non-empty / non-null value | | `gt` | greater than | Attribute value is greater than the operator value | | `ge` | greater than or equal | Attribute value is greater than or equal to the operator value | | `lt` | less than | Attribute value is less than the operator value | | `le` | less than or equal | Attribute value is less than or equal to the operator value | For `gt`/`ge`/`lt`/`le`, strings compare lexicographically, dates chronologically and numbers numerically. Each list endpoint documents the fields you can filter on. **Examples** | Filter | Result | |--------|--------| | `firstName sw "Jan"` | People whose first name starts with "Jan" | | `teams[name eq "Developers"]` | People in the team called Developers | | `not (leavingDate pr)` | People with no leaving date | | `lastModifiedDtm ge "2021-06-01"` | Records modified on or after 1 June 2021 | ## Errors A `400 Bad Request` indicates a problem with your request. The body is a problem-details object: `errors` maps each offending field to its messages, with `title`, `status`, a `type` URL, and an `extensions.traceId` for correlation: ```json { "errors": { "leavingDate": [ "Error converting value \"2020-40-40\" ..." ] }, "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "extensions": { "traceId": "00-91e4405b...-00" } } ``` You should not normally see `500 Internal Server Error`. If you do, the body is a generic message — please contact [saasmanager@1password.com](mailto:saasmanager@1password.com) with details of the request so we can investigate. ## Scopes Scopes define what an API app may do. Following security best practice, grant only the scopes you need. Each endpoint documents the scope(s) it requires. | Scope | Description | |-------|-------------| | `Apps.Read` | Read-only access to applications | | `Apps.Users.Read` | Read-only access to application accounts | | `Apps.Write` | Write access to applications | | `Assets.Read` | Read-only access to devices | | `Assets.Write` | Write access to devices | | `AuditLog.Read` | Read-only access to the audit log | | `Contracts.Read` | Read-only access to contracts | | `Contracts.Write` | Write access to contracts | | `People.Read` | Read-only access to people and teams | | `People.Write` | Write access to people and teams | | `Users.Read` | Read-only access to users with access to SaaS Manager | | `Users.Write` | Write access to users with access to SaaS Manager | | `Workflows.Read` | Read-only access to workflow definitions | | `Workflows.Runs.Read` | Read-only access to workflow runs | | `Workflows.Runs.Execute` | Execute workflow run actions | | `Workflows.Runs.ReadSecrets` | Read workflow run secrets | | `offline_access` | Issue a refresh token alongside the access token (Authorization Code flow) | contact: name: 1Password SaaS Manager Support email: saasmanager@1password.com version: v1 servers: - url: https://app.trelica.com description: United States - url: https://eu.trelica.com description: Europe security: [] tags: - name: Authentication description: >- Obtain an OAuth 2.0 access token. Use the Client Credentials flow for machine-to-machine access, or the Authorization Code flow to act on behalf of a user. - name: Applications description: >- List, search and manage applications, and list the accounts (users) on an application. - name: People description: List, search and manage the people in your organization. - name: Teams description: List and manage teams and the team hierarchy. - name: Contracts description: List and manage contracts. - name: Devices description: List and manage devices. The endpoints live under `/api/assets`. - name: Workflows description: >- List workflows (with their triggers and steps), list their runs, and fire signals on steps that are waiting for input. - name: Audit log description: >- Read your organization's audit log: a continuous, filterable stream of events. - name: SCIM description: >- Provision and manage users via the SCIM 2.0 protocol (RFC 7644). These endpoints follow the SCIM standard rather than the conventions used by the rest of the SaaS Manager API: they use `startIndex`/`count` paging, return a SCIM `ListResponse` envelope, identify schemas with `urn:` URIs, and exchange `application/scim+json`. The `ResourceTypes` endpoints support SCIM discovery (RFC 7643). paths: /api/people/v1/{id}: get: tags: - People summary: Get a person description: >- Fetches a single person by their SaaS Manager ID (a UUID) or by email address. If an email address matches more than one person a 409 Conflict is returned. **Required scope:** `People.Read` (Read-only access to people and teams) parameters: - name: id in: path description: The person's SaaS Manager ID (UUID) or an email address. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Person' example: id: 123e4567e89b12d3a456426614174000 employeeType: Part-time personType: Employee aliases: - john.doe@example.com - john@example.com - j.doe@example.com - johnny.d@example.com userName: johndoe123 firstName: John lastName: Doe email: john.doe@example.com jobTitle: Customer Success Manager organizationalUnit: / loginName: johndoe employeeId: '123' status: Active lineManager: id: 765e4321b98e21d3b456426614174000 personType: User name: Jane Smith email: jane.smith@example.com teams: - id: 65207c3ffa0d2abb07955316 name: Customer Success createdBy: userId: 321cba98-765e-4321-0d3b-456789abcdef name: System email: admin@example.com createdDtm: '2020-03-09T06:09:26Z' lastModifiedBy: userId: 321cba98-765e-4321-0d3b-456789abcdef name: System email: admin@example.com lastModifiedDtm: '2024-05-26T01:01:43Z' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: Not found. status: 404 detail: >- The requested resource does not exist or you do not have access to it. traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: Conflict. status: 409 detail: >- The request conflicts with the current state (for example, the resource already exists). traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 security: - oauth2: - People.Read components: schemas: Person: type: object properties: id: type: string description: The person's unique ID employeeType: type: string description: >- A free-text employee type (e.g. full-time, part-time). Distinct from personType. personType: allOf: - $ref: '#/components/schemas/PersonType' description: >- Classifies the person: Employee, Contractor, ServiceAccount or External. Distinct from the free-text employeeType. aliases: type: array items: type: string description: Email addresses linked to this person userName: type: string description: The user's logon name (from integrations) firstName: type: string description: First name lastName: type: string description: Last name email: type: string description: Primary email address jobTitle: type: string description: Job title locationId: type: string description: The location's unique identifier (derived from location) location: type: string description: >- A description of the user's location. A matching location is found or created when set. locationCountryCode: type: string description: The user's country (derived from location) locationTimezone: type: string description: >- The IANA time zone name of the user's location, e.g. `America/New_York` (derived from location) costCenterId: type: string description: The ID of the cost center (derived from costCenter) costCenter: type: string description: Cost center. A matching cost center is found or created when set. organizationalUnit: type: string description: >- The organizational unit, sourced from directory integrations (e.g. Google Workspace, Active Directory). loginName: type: string description: >- The person's login name on the local domain. Used in conjunction with the SaaS Manager Browser Extension Helper to determine the identity of the logged in user. timezone: type: string description: The person's IANA time zone name, e.g. `America/New_York` employeeId: type: string description: Employee ID phoneNumber: type: string description: Phone number status: allOf: - $ref: '#/components/schemas/PersonStatus' description: Status (new, terminated, etc) personalAddress: allOf: - $ref: '#/components/schemas/AddressDetails' description: Home address lineManager: allOf: - $ref: '#/components/schemas/PersonInfo' description: >- The person's line manager. On input, set it by the line manager's id or email (other fields are ignored); alternatively use lineManagerId or lineManagerEmail. These three forms are mutually exclusive. teams: type: array items: $ref: '#/components/schemas/Team' description: >- The teams the person belongs to. When creating or replacing, supply teams by ID, or by name (a team is created if the name is not found); mutually exclusive with teamIds. customFields: type: object additionalProperties: $ref: '#/components/schemas/PersonCustomFieldValue' description: Custom field values startDate: type: string description: >- (ISO format) Date that the person joined the organization. Passing null clears the date. format: date-time leavingDate: type: string description: >- (ISO format) Date that the person left the organization or is due to lave. Passing null clears the date. format: date-time createdBy: allOf: - $ref: '#/components/schemas/UserInfo' description: The user that created the person record createdDtm: type: string description: The timestamp for when the person record was created format: date-time lastModifiedBy: allOf: - $ref: '#/components/schemas/UserInfo' description: The user that last modified the person record lastModifiedDtm: type: string description: The timestamp for when the person record was last modified format: date-time additionalProperties: false description: A SaaS Manager person Error: type: object properties: type: type: string description: A URI reference identifying the problem type. title: type: string description: A short, human-readable summary of the problem. status: type: integer description: The HTTP status code. format: int32 detail: type: string description: >- A human-readable explanation specific to this occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: Validation errors keyed by field name. Present on 400 responses. traceId: type: string description: >- A trace identifier for correlating the error with SaaS Manager support. additionalProperties: false description: An error response (RFC 7807 problem details). PersonType: enum: - Employee - Contractor - ServiceAccount - External type: string PersonStatus: enum: - New - Terminated - Active - Unknown type: string AddressDetails: type: object properties: streetAddress1: type: string nullable: true streetAddress2: type: string nullable: true city: type: string nullable: true stateOrProvince: type: string nullable: true zipOrPostalCode: type: string nullable: true countryCode: type: string nullable: true additionalProperties: false PersonInfo: type: object properties: id: type: string nullable: true personType: allOf: - $ref: '#/components/schemas/PersonValueType' name: type: string nullable: true email: type: string nullable: true additionalProperties: false Team: type: object properties: id: type: string description: The team's unique ID. Omit when creating a team by name. nullable: true name: type: string description: The team's name nullable: true additionalProperties: false description: A team that a person can belong to PersonCustomFieldValue: type: object properties: numberValue: type: number format: double nullable: true optionValue: type: array items: type: string nullable: true textValue: type: string nullable: true dateValue: type: string format: date-time nullable: true linkValue: allOf: - $ref: '#/components/schemas/PersonLinkValue' nullable: true personValue: allOf: - $ref: '#/components/schemas/PersonPersonValue' nullable: true additionalProperties: false UserInfo: type: object properties: userId: type: string nullable: true name: type: string nullable: true email: type: string nullable: true additionalProperties: false PersonValueType: enum: - Contact - User type: string PersonLinkValue: type: object properties: href: type: string nullable: true description: type: string nullable: true additionalProperties: false PersonPersonValue: type: object properties: id: type: string nullable: true personType: allOf: - $ref: '#/components/schemas/PersonValueType' name: type: string nullable: true email: type: string nullable: true externalId: type: string nullable: true additionalProperties: false securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as `Authorization: Bearer `. flows: clientCredentials: tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) authorizationCode: authorizationUrl: https://app.trelica.com/connect/authorize tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) ```` ## Related topics - [List a person's applications](/api-reference/people/list-a-persons-applications.md) - [Create or replace a person](/api-reference/people/create-or-replace-a-person.md) - [Get a workflow run](/api-reference/workflows/get-a-workflow-run.md)