Salesforce Identifiers API

The Identifiers API from Salesforce — 6 operation(s) for identifiers.

Documentation

Specifications

Schemas & Data

OpenAPI Specification

salesforce-identifiers-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Salesforce Bulk API 2.0 Abort Identifiers API
  description: 'Salesforce Bulk API 2.0 is a simplified, REST-based interface for bulk data operations that improves on the original Bulk API. It uses a straightforward job model and supports CSV format for ingest and query jobs, enabling processing of millions of records asynchronously.

    '
  version: v63.0
  contact:
    name: Salesforce Developers
    url: https://developer.salesforce.com/
  license:
    name: Salesforce Developer Terms
    url: https://www.salesforce.com/company/legal/agreements/
servers:
- url: https://{instance}.salesforce.com/services/data/v{version}/jobs
  description: Salesforce Bulk API 2.0 jobs endpoint
  variables:
    instance:
      default: yourInstance
      description: 'The Salesforce instance identifier (e.g., na1, eu3, or a My Domain subdomain like mycompany).

        '
    version:
      default: '63.0'
      description: 'The Salesforce API version number (e.g., 63.0). Use the latest supported version for new integrations.

        '
security:
- BearerAuth: []
tags:
- name: Identifiers
paths:
  //:
    parameters: []
    get:
      tags:
      - Identifiers
      summary: Salesforce Id Token
      operationId: IDToken
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Thu, 16 Nov 2023 15:56:09 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-XSS-Protection:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: 1; mode=block
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/SuccessfulIDToken'
                - examples:
                  - id: https://login.salesforce.com/id/00D.../005...
                    asserted_user: true
                    user_id: 005...
                    organization_id: 00D...
                    username: <username>
                    nick_name: <nickname>
                    display_name: <display_name>
                    email: <email>
                    email_verified: true
                    first_name: <firstname>
                    last_name: <lastname>
                    timezone: Europe/Paris
                    photos:
                      picture: https://<my_domain>/profilephoto/005/F
                      thumbnail: https://<my_domain>/profilephoto/005/T
                    addr_street: null
                    addr_city: null
                    addr_state: null
                    addr_country: FR
                    addr_zip: null
                    mobile_phone: null
                    mobile_phone_verified: false
                    is_lightning_login_user: false
                    status:
                      created_date: null
                      body: null
                    urls:
                      enterprise: https://<my_domain>/services/Soap/c/{version}/00D...
                      metadata: https://<my_domain>/services/Soap/m/{version}/00D...
                      partner: https://<my_domain>/services/Soap/u/{version}/00D...
                      rest: https://<my_domain>/services/data/v{version}/
                      sobjects: https://<my_domain>/services/data/v{version}/sobjects/
                      search: https://<my_domain>/services/data/v{version}/search/
                      query: https://<my_domain>/services/data/v{version}/query/
                      recent: https://<my_domain>/services/data/v{version}/recent/
                      tooling_soap: https://<my_domain>/services/Soap/T/{version}/00D...
                      tooling_rest: https://<my_domain>/services/data/v{version}/tooling/
                      profile: https://<my_domain>/0052o00000DOJ1PAAX
                      feeds: https://<my_domain>/services/data/v{version}/chatter/feeds
                      groups: https://<my_domain>/services/data/v{version}/chatter/groups
                      users: https://<my_domain>/services/data/v{version}/chatter/users
                      feed_items: https://<my_domain>/services/data/v{version}/chatter/feed-items
                      feed_elements: https://<my_domain>/services/data/v{version}/chatter/feed-elements
                      custom_domain: https://<my_domain>
                    active: true
                    user_type: STANDARD
                    language: en_US
                    locale: fr_FR_EURO
                    utcOffset: 3600000
                    last_modified_date: <date_time>
                    is_app_installed: true
                contentMediaType: application/json;charset=UTF-8
              example:
                id: https://login.salesforce.com/id/00D.../005...
                asserted_user: true
                user_id: 005...
                organization_id: 00D...
                username: <username>
                nick_name: <nickname>
                display_name: <display_name>
                email: <email>
                email_verified: true
                first_name: <firstname>
                last_name: <lastname>
                timezone: Europe/Paris
                photos:
                  picture: https://<my_domain>/profilephoto/005/F
                  thumbnail: https://<my_domain>/profilephoto/005/T
                addr_street: null
                addr_city: null
                addr_state: null
                addr_country: FR
                addr_zip: null
                mobile_phone: null
                mobile_phone_verified: false
                is_lightning_login_user: false
                status:
                  created_date: null
                  body: null
                urls:
                  enterprise: https://<my_domain>/services/Soap/c/{version}/00D...
                  metadata: https://<my_domain>/services/Soap/m/{version}/00D...
                  partner: https://<my_domain>/services/Soap/u/{version}/00D...
                  rest: https://<my_domain>/services/data/v{version}/
                  sobjects: https://<my_domain>/services/data/v{version}/sobjects/
                  search: https://<my_domain>/services/data/v{version}/search/
                  query: https://<my_domain>/services/data/v{version}/query/
                  recent: https://<my_domain>/services/data/v{version}/recent/
                  tooling_soap: https://<my_domain>/services/Soap/T/{version}/00D...
                  tooling_rest: https://<my_domain>/services/data/v{version}/tooling/
                  profile: https://<my_domain>/0052o00000DOJ1PAAX
                  feeds: https://<my_domain>/services/data/v{version}/chatter/feeds
                  groups: https://<my_domain>/services/data/v{version}/chatter/groups
                  users: https://<my_domain>/services/data/v{version}/chatter/users
                  feed_items: https://<my_domain>/services/data/v{version}/chatter/feed-items
                  feed_elements: https://<my_domain>/services/data/v{version}/chatter/feed-elements
                  custom_domain: https://<my_domain>
                active: true
                user_type: STANDARD
                language: en_US
                locale: fr_FR_EURO
                utcOffset: 3600000
                last_modified_date: <date_time>
                is_app_installed: true
      deprecated: false
      servers:
      - url: https://id
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/event/eventSchema/{SCHEMA_ID}:
    parameters: []
    get:
      tags:
      - Identifiers
      summary: Salesforce Platform Event Schema by Schema Id
      description: Set, reset, or get information about a user password. This resource is available in REST API version 24.0 and later.
      operationId: PlatformEventSchemabySchemaID
      parameters:
      - name: SCHEMA_ID
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/tooling/sobjects/ManagedEventSubscription/{managedEventSubscriptionId}:
    parameters: []
    get:
      tags:
      - Identifiers
      summary: Salesforce Get Managed Event Subscription by Id
      operationId: GetmanagedeventsubscriptionbyID
      parameters:
      - name: managedEventSubscriptionId
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/sobjects/{SOBJECT_API_NAME}/{FIELD_NAME}/{FIELD_VALUE}:
    parameters: []
    get:
      tags:
      - Identifiers
      summary: Salesforce Sobject Rows by External Id
      description: 'Creates new records or updates existing records (upserts records) based on the value of a specified external ID field.


        If the specified value doesn''t exist, a new record is created.

        If a record does exist with that value, the field values specified in the request body are updated.

        If the value is not unique, the REST API returns a 300 response with the list of matching records.


        HEAD, GET, PATCH, DELETE, POST'
      operationId: SObjectRowsbyExternalID
      parameters:
      - name: SOBJECT_API_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_NAME
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: FIELD_VALUE
        in: path
        description: ''
        required: true
        schema:
          type: string
        example: example_value
      - name: Content-Type
        in: header
        description: ''
        required: true
        schema:
          const: application/json
          type: string
          examples:
          - application/json
        example: example_value
      responses:
        '200':
          description: ''
          headers: {}
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /data/v64.0/ui-api/list-records/{LIST_VIEW_ID}:
    parameters: []
    get:
      tags:
      - Identifiers
      summary: Salesforce Get List View Records by Id
      description: Get record data for a list view by list view ID using URL parameters.
      operationId: GetListViewRecordsbyID
      parameters:
      - name: LIST_VIEW_ID
        in: path
        description: The ID of a list view.
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: OK
          headers:
            Date:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Fri, 06 Oct 2023 09:52:06 GMT
            Strict-Transport-Security:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: max-age=63072000; includeSubDomains
            X-Content-Type-Options:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: nosniff
            X-Robots-Tag:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: none
            Cache-Control:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: no-cache,must-revalidate,max-age=0,no-store,private
            Vary:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: Accept-Encoding
            Content-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: gzip
            Transfer-Encoding:
              content:
                text/plain:
                  schema:
                    type: string
                    contentMediaType: text/plain
                  example: chunked
          content:
            application/json;charset=UTF-8:
              schema:
                allOf:
                - $ref: '#/components/schemas/GetListViewRecordsbyID'
                - examples:
                  - count: 50
                    currentPageToken: '0'
                    currentPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=0
                    fields: []
                    listInfoETag: 55ebdd0de6c2f1e17f63bf4581d64f76
                    listReference:
                      id: 00B58000002ssinEAA
                      listViewApiName: AllAccounts
                      objectApiName: Account
                      type: listView
                    nextPageToken: '50'
                    nextPageUrl: /services/data/v62.0/ui-api/list-records/00B58000002ssinEAA?pageSize=50&pageToken=50
                    optionalFields: []
                    pageSize: 50
                    previousPageToken: null
                    previousPageUrl: null
                    records:
                    - apiName: Account
                      childRelationships: {}
                      eTag: c7b296e1aa5fa482e1f77e8dc0e0b5e1
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2020-02-27T09:28:06.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002LbR7QQAV
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Name:
                          displayValue: null
                          value: ABC Computing
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: '123123123'
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2023-10-04T18:35:13.000Z'
                        Type:
                          displayValue: null
                          value: null
                      id: 0014H00002LbR7QQAV
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2023-10-04T18:35:13.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2023-10-04T18:35:13.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: cfeff90a24208129b7cf7be4e47dda99
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOhAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Name:
                          displayValue: null
                          value: Burlington Textiles Corp of America
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (336) 222-7000
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T16:04:02.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOhAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T16:04:02.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T16:04:02.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: c42c5257506520c737965101b225840c
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: USA
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOjAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Name:
                          displayValue: null
                          value: Dickenson Co.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (785) 241-6200
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2020-09-29T15:52:06.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOjAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2020-09-29T15:52:06.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2020-09-29T15:52:06.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: 2f21e61d45d05263809593342f5761f4
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: France
                        CreatedDate:
                          displayValue: null
                          value: '2016-05-09T13:51:39.000Z'
                        Id:
                          displayValue: null
                          value: 00158000006QBOiAAO
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Name:
                          displayValue: null
                          value: Pyramid Construction Inc.
                        Owner:
                          displayValue: Philippe Ozil
                          value:
                            apiName: User
                            childRelationships: {}
                            eTag: cd72f37056763253524392799303114f
                            fields:
                              Alias:
                                displayValue: null
                                value: POzil
                              CreatedDate:
                                displayValue: null
                                value: '2016-05-09T13:51:39.000Z'
                              Id:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedById:
                                displayValue: null
                                value: 00558000000yFyDAAU
                              LastModifiedDate:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                              Name:
                                displayValue: null
                                value: Philippe Ozil
                              SystemModstamp:
                                displayValue: null
                                value: '2023-10-06T08:34:22.000Z'
                            id: 00558000000yFyDAAU
                            lastModifiedById: 00558000000yFyDAAU
                            lastModifiedDate: '2023-10-06T08:34:22.000Z'
                            recordTypeId: null
                            recordTypeInfo: null
                            systemModstamp: '2023-10-06T08:34:22.000Z'
                        OwnerId:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        Phone:
                          displayValue: null
                          value: (014) 427-4427
                        Site:
                          displayValue: null
                          value: null
                        SystemModstamp:
                          displayValue: null
                          value: '2016-05-11T08:48:05.000Z'
                        Type:
                          displayValue: Customer
                          value: Customer
                      id: 00158000006QBOiAAO
                      lastModifiedById: 00558000000yFyDAAU
                      lastModifiedDate: '2016-05-11T08:48:05.000Z'
                      recordTypeId: 012000000000000AAA
                      recordTypeInfo: null
                      systemModstamp: '2016-05-11T08:48:05.000Z'
                    - apiName: Account
                      childRelationships: {}
                      eTag: a5b391b1caf935de4bbc96858a4e6a12
                      fields:
                        BillingCountry:
                          displayValue: null
                          value: null
                        CreatedDate:
                          displayValue: null
                          value: '2020-02-04T18:26:08.000Z'
                        Id:
                          displayValue: null
                          value: 0014H00002E6wi6QAB
                        LastModifiedById:
                          displayValue: null
                          value: 00558000000yFyDAAU
                        LastModifiedDate:
                          displayValue: null
                          value: '2020-02-04T18:26:08.000Z'
                        Name:
                          displayValue: null
                          value: Sample Account
                        Owner:
                          displayValue: Philippe Ozil
                       

# --- truncated at 32 KB (538 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/salesforce/refs/heads/main/openapi/salesforce-identifiers-api-openapi.yml