> ## Documentation Index > Fetch the complete documentation index at: https://developers.firstbase.com/llms.txt > Use this file to discover all available pages before exploring further. # List people > Returns a paginated SCIM ListResponse of people in the caller's organization. Filter by email address or name using SCIM filter expressions. Maximum of 50 users per page. ## OpenAPI ````yaml /openapi.json get /scim/v2/Users openapi: 3.1.0 info: title: Firstbase API Specification description: Integration endpoints for Firstbase version: 0.1.0 servers: - url: http://localhost:8081 description: Production security: - ApiKey: [] tags: - name: Catalog description: Browse SKUs, brands, and categories - name: Inventory description: Query and manage inventory items and assets - name: Inventory Levels description: Configure inventory levels by SKU and warehouse - name: Inventory Orders description: Create and manage inventory orders - name: ITAD description: IT asset disposition requests - name: New Joiners description: Track and remind new joiners - name: Offices description: Manage office locations - name: Orders description: Create and track equipment orders - name: Packages description: Manage equipment packages - name: People description: Provision and manage users - name: Regions description: Query regions - name: Replacements description: Create and manage equipment replacements - name: Returns description: Create and manage returns - name: Shipment description: Look up shipments and carriers - name: Shipment Notices description: Create and manage shipment notices - name: Warehouses description: Query warehouses paths: /scim/v2/Users: get: tags: - People summary: List people description: >- Returns a paginated SCIM ListResponse of people in the caller's organization. Filter by email address or name using SCIM filter expressions. Maximum of 50 users per page. operationId: listUsers parameters: - name: filter in: query description: |- Fetch user with a given name or email address using SCIM operators Examples: emails.value eq "test@email.com" name.givenName eq "James" and name.familyName eq "Bond" schema: type: string - name: startIndex in: query description: The 1-based start index of the first user to be returned schema: type: integer example: 1 - name: count in: query description: >- The number of users to be returned. A maximum of 50 users will be returned in a page. schema: type: integer example: 100 - name: attributes in: query description: >- Comma-separated SCIM defined attributes to be returned. Required attributes are always returned schema: type: string - name: excludedAttributes in: query description: >- Comma-separated SCIM defined attributes to be excluded. Required attributes cannot be excluded schema: type: string responses: '200': description: List of users content: application/scim+json: schema: $ref: '#/components/schemas/UsersSchema' '400': description: Bad Request content: '*/*': schema: $ref: '#/components/schemas/PublicApiHttpErrors' '404': description: Not Found content: '*/*': schema: $ref: '#/components/schemas/PublicApiHttpErrors' '409': description: Conflict content: '*/*': schema: $ref: '#/components/schemas/PublicApiHttpErrors' x-codeSamples: - lang: curl label: cURL source: >- curl -sS -X GET 'http://localhost:8081/scim/v2/Users?startIndex=1&count=100' \ -H 'Authorization: ApiKey YOUR_API_KEY' \ -H 'Accept: application/json' components: schemas: UsersSchema: type: object properties: totalResults: type: integer format: int64 description: The total number of users available example: 102 itemsPerPage: type: integer format: int32 description: The number of users in the returned page example: 1 startIndex: type: integer format: int32 description: The 1-based index of the first user in the returned page example: 1 Resources: type: array description: A page of users items: $ref: '#/components/schemas/UserSchema' schemas: type: array description: The schemas defining the attributes of the user resources list. example: - urn:ietf:params:scim:api:messages:2.0:ListResponse items: type: string required: - Resources - itemsPerPage - schemas - startIndex - totalResults PublicApiHttpErrors: type: object properties: errors: type: array items: $ref: '#/components/schemas/PublicApiError' description: List of error details. required: - errors UserSchema: type: object properties: id: type: string format: uuid description: >- SCIM id of the person (Firstbase person UUID). Read-only on responses. readOnly: true addresses: type: array description: >- A physical mailing address for this user. If multiple addresses are present, the element that will be used as the user's Firstbase address will be selected by the following precedence: type `home` marked as `primary`, the first `home` address, the `primary` address, otherwise the first provided address. items: $ref: '#/components/schemas/Address' userName: type: string description: The userName must match the `primary` email address. example: jenny.smith@example.com emails: type: array description: >- Email addresses for the user. If multiple addresses are present, the `primary` will be used, otherwise the first element will be the user's Firstbase primary email AND userName. items: $ref: '#/components/schemas/Email' name: $ref: '#/components/schemas/Name' description: The components of the user's name. phoneNumbers: type: array description: >- Phone numbers for the user. The value SHOULD be specified according to the format defined in [RFC3966], e.g., 'tel:+1-201-555-0123' If multiple phone numbers are present, the `primary` otherwise the first element will be the user's Firstbase phone number. items: $ref: '#/components/schemas/PhoneNumber' urn:ietf:params:scim:schemas:extension:firstbase:1.0:User: type: object description: >- Firstbase onboarding attributes for the user (package, start date, status, CPF, activation). properties: packageId: type: string format: uuid description: >- UUID of the equipment package to assign. If the package has automatic ordering enabled, Firstbase may create equipment orders when the person is provisioned. example: d1b0fd87-5fc9-410c-b641-0b7146896ccd startDate: type: string description: >- Person start date (ISO-8601 date, YYYY-MM-DD). Used for new-joiner scheduling and related onboarding workflows. example: '2022-02-01' status: type: string description: Current status of the resource. enum: - INVITED - ACTIVE - INACTIVE - DELETED - OFFBOARDING - CANNOT_REACTIVATE example: ACTIVE skipUserActivation: type: boolean description: >- When true, Firstbase creates the person without granting App User access and without provisioning an Okta login. Use for records that should exist for ordering/inventory only. When false (default), the person is activated as an App User and can receive activation/invite flows. example: false cpfNumber: type: string description: >- Brazilian CPF tax identifier when required for shipping or compliance in supported regions. Digits only; omit when not applicable. example: 87456236985 required: - skipUserActivation schemas: type: array description: The schemas defining the attributes of the resources. example: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:extension:firstbase:1.0:User items: type: string required: - addresses - emails - id - name - schemas - urn:ietf:params:scim:schemas:extension:firstbase:1.0:User - userName PublicApiError: type: object properties: detail: type: string description: Human-readable description of the error example: Invalid request source: type: string description: >- Entity or field path that caused the error (for example order, shipmentNotice, or person:email) example: request required: - detail - source Address: type: object properties: country: type: string description: >- The country name component. The value MUST be in ISO 3166-1 "alpha-2" code format. example: US locality: type: string description: The city or locality component. example: New York City postalCode: type: string description: The zip code or postal code component. example: 10123 region: type: string description: The state or region component. example: NY streetAddress: type: string description: >- The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines. Only the first 2 lines will be used. example: 123 primary: type: boolean description: When true, the address will be the user's mailing address. example: true required: - country Email: type: object properties: value: type: string description: Email address. The primary email must match `userName`. example: jenny.smith@example.com primary: type: boolean description: When true, this is the user's primary email address. example: true required: - value Name: type: object properties: familyName: type: string description: Family name / last name of the person. example: Smith givenName: type: string description: Given name / first name of the person. example: Jenny required: - familyName - givenName PhoneNumber: type: object properties: value: type: string description: >- Phone number. Prefer E.164 / RFC3966 format (for example `tel:+1-201-555-0123`). example: 1+555-867-5309 primary: type: boolean description: When true, this is the user's primary phone number. example: true required: - value securitySchemes: ApiKey: type: apiKey description: Prefix the value with "ApiKey" to indicate the custom authorization type name: Authorization in: header ````