Popp Organizations API

openapi: 3.2.0
info:
  title: Popp Organizations API
  description: Popp API documentation
  version: '1'
servers:
- url: https://api.joinpopp.com
  description: Development server
security:
- popp_api_key: []
  organization_id: []
tags:
- name: Organizations
paths:
  /v1/organizations:
    get:
      summary: List Organizations
      description: 'List the organizations the authenticated user can access. Organization-group admins receive every organization in their group; other users receive the organizations they are a member of. This endpoint is authenticated with your API key alone: the `x-organization-id` header is not required (it is scoped to the user behind the API key). Use a returned organization id as the `x-organization-id` header to scope subsequent requests to that organization.'
      operationId: list-organizations
      parameters:
      - name: limit
        in: query
        description: Maximum number of items per page (1-50). Defaults to 20.
        required: false
        schema:
          $ref: '#/components/schemas/limit-7528f827-6a22-4938-8e75-e72819e20066'
      - name: nextToken
        in: query
        description: Pagination token returned by a previous call.
        required: false
        schema:
          $ref: '#/components/schemas/nextToken'
      tags:
      - Organizations
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListOrganizationsResponse'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
  /v1/organizations/{id}:
    patch:
      summary: Update Organization
      description: Update an organization's name and/or your own external identifier for it. Provide at least one field. Scoped to the organization group behind your API key; an organization in another group returns 404. Authenticated with your API key alone.
      operationId: update-organization-details
      parameters:
      - name: id
        in: path
        description: The organization id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Organizations
      security:
      - popp_api_key: []
      requestBody:
        description: The organization fields to update.
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOrganizationRequest'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSummary'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
    get:
      summary: Get Organization
      description: Get a single organization by id, including your own external identifier for it. Scoped to the organization group behind your API key; an organization in another group returns 404. Authenticated with your API key alone.
      operationId: get-organization-details
      parameters:
      - name: id
        in: path
        description: The organization id.
        required: true
        schema:
          $ref: '#/components/schemas/id'
      tags:
      - Organizations
      security:
      - popp_api_key: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrganizationSummary'
          headers: {}
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '401':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          headers: {}
components:
  schemas:
    UpdateOrganizationRequest:
      title: UpdateOrganizationRequest
      description: At least one of name or externalOrganizationId must be provided.
      type: object
      properties:
        name:
          type: string
          description: The organization's display name.
        externalOrganizationId:
          type: string
          description: Your own identifier for this organization, echoed back on user and organization responses.
      minProperties: 1
      additionalProperties: false
    nextToken:
      type: string
    ListOrganizationsResponse:
      type: object
      properties:
        items:
          type: array
          description: Organizations the authenticated user can access.
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              organizationGroupId:
                type:
                - string
                - 'null'
              externalOrganizationId:
                type:
                - string
                - 'null'
                description: Your own external identifier for the organization, or null if none is set.
              isHidden:
                type: boolean
                description: Whether the organization is hidden.
            required:
            - id
            - name
            - organizationGroupId
            - externalOrganizationId
            - isHidden
            additionalProperties: false
        nextToken:
          type:
          - string
          - 'null'
          description: Pass back as `nextToken` to fetch the next page. Null when there are no more results.
      required:
      - items
      - nextToken
      additionalProperties: false
    ErrorResponse:
      type: object
    limit-7528f827-6a22-4938-8e75-e72819e20066:
      type: integer
      minimum: 1
      maximum: 50
    id:
      type: string
    OrganizationSummary:
      title: OrganizationSummary
      description: An organization's identity fields.
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the organization.
        name:
          type: string
          description: Name of the organization.
        organizationGroupId:
          type:
          - string
          - 'null'
          description: The organization group this organization belongs to.
        externalOrganizationId:
          type:
          - string
          - 'null'
          description: Your own identifier for this organization, if one has been set.
        isHidden:
          type: boolean
          description: Whether the organization is hidden.
      required:
      - id
      - name
      - organizationGroupId
      - externalOrganizationId
      - isHidden
      additionalProperties: false
  securitySchemes:
    popp_api_key:
      description: Your Popp API key for authentication
      type: apiKey
      name: x-api-key
      in: header
    organization_id:
      description: Your organization's unique identifier
      type: apiKey
      name: x-organization-id
      in: header
x-provenance:
  method: searched
  source: https://docs.joinpopp.com/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.joinpopp.com/reference/add-candidates-to-list-by-external-id.md
  - https://docs.joinpopp.com/reference/add-candidates-to-list.md
  - https://docs.joinpopp.com/reference/archive-analysis.md
  - https://docs.joinpopp.com/reference/archive-document-type.md
  - https://docs.joinpopp.com/reference/archive-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/archive-workflow.md
  - https://docs.joinpopp.com/reference/bulk-create-conversations.md
  - https://docs.joinpopp.com/reference/cancel-booking.md
  - https://docs.joinpopp.com/reference/cancel-workflow-run.md
  - https://docs.joinpopp.com/reference/create-analysis-candidate.md
  - https://docs.joinpopp.com/reference/create-analysis.md
  - https://docs.joinpopp.com/reference/create-campaign.md
  - https://docs.joinpopp.com/reference/create-candidate-list.md
  - https://docs.joinpopp.com/reference/create-candidate-note-by-external-id.md
  - https://docs.joinpopp.com/reference/create-candidate-note.md
  - https://docs.joinpopp.com/reference/create-candidate.md
  - https://docs.joinpopp.com/reference/create-conversation.md
  - https://docs.joinpopp.com/reference/create-custom-field.md
  - https://docs.joinpopp.com/reference/create-document-credential.md
  - https://docs.joinpopp.com/reference/create-document-type.md
  - https://docs.joinpopp.com/reference/create-meeting-template.md
  - https://docs.joinpopp.com/reference/create-organization-config.md
  - https://docs.joinpopp.com/reference/create-scheduling-conversation.md
  - https://docs.joinpopp.com/reference/create-user.md
  - https://docs.joinpopp.com/reference/create-webhook.md
  - https://docs.joinpopp.com/reference/create-workflow.md
  - https://docs.joinpopp.com/reference/deactivate-user-by-email.md
  - https://docs.joinpopp.com/reference/deactivate-user.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-email.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/delete-candidate-by-phone-number.md
  - https://docs.joinpopp.com/reference/delete-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/delete-candidate-list.md
  - https://docs.joinpopp.com/reference/delete-candidate-note.md
  - https://docs.joinpopp.com/reference/delete-candidate.md
  - https://docs.joinpopp.com/reference/delete-custom-field.md
  - https://docs.joinpopp.com/reference/delete-document-credential.md
  - https://docs.joinpopp.com/reference/delete-document-type.md
  - https://docs.joinpopp.com/reference/delete-meeting-template.md
  - https://docs.joinpopp.com/reference/delete-tag.md
  - https://docs.joinpopp.com/reference/delete-user-by-email.md
  - https://docs.joinpopp.com/reference/delete-user.md
  - https://docs.joinpopp.com/reference/delete-webhook.md
  - https://docs.joinpopp.com/reference/download-media.md
  - https://docs.joinpopp.com/reference/generate-preferred-answer-requirements.md
  - https://docs.joinpopp.com/reference/generate-questions.md
  - https://docs.joinpopp.com/reference/generate-requirements.md
  - https://docs.joinpopp.com/reference/get-analysis.md
  - https://docs.joinpopp.com/reference/get-booking.md
  - https://docs.joinpopp.com/reference/get-campaign.md
  - https://docs.joinpopp.com/reference/get-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate-list.md
  - https://docs.joinpopp.com/reference/get-candidate-profile-by-external-id.md
  - https://docs.joinpopp.com/reference/get-candidate.md
  - https://docs.joinpopp.com/reference/get-conversation.md
  - https://docs.joinpopp.com/reference/get-custom-field.md
  - https://docs.joinpopp.com/reference/get-document-media.md
  - https://docs.joinpopp.com/reference/get-document-type.md
  - https://docs.joinpopp.com/reference/get-document.md
  - https://docs.joinpopp.com/reference/get-meeting-template.md
  - https://docs.joinpopp.com/reference/get-organization-config-by-external-id.md
  - https://docs.joinpopp.com/reference/get-organization-config.md
  - https://docs.joinpopp.com/reference/get-organization-details.md
  - https://docs.joinpopp.com/reference/get-user-by-email.md
  - https://docs.joinpopp.com/reference/get-user-calendar.md
  - https://docs.joinpopp.com/reference/get-user.md
  - https://docs.joinpopp.com/reference/get-workflow-analysis-application.md
  - https://docs.joinpopp.com/reference/get-workflow-analysis.md
  - https://docs.joinpopp.com/reference/get-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/get-workflow-run.md
  - https://docs.joinpopp.com/reference/get-workflow.md
  - https://docs.joinpopp.com/reference/hand-conversation-to-agent.md
  - https://docs.joinpopp.com/reference/invite-calendar-contact.md
  - https://docs.joinpopp.com/reference/list-agents.md
  - https://docs.joinpopp.com/reference/list-analyses.md
  - https://docs.joinpopp.com/reference/list-ats-job-stages.md
  - https://docs.joinpopp.com/reference/list-ats-jobs.md
  - https://docs.joinpopp.com/reference/list-ats-rejection-reasons.md
  - https://docs.joinpopp.com/reference/list-bookings.md
  - https://docs.joinpopp.com/reference/list-campaigns.md
  - https://docs.joinpopp.com/reference/list-candidate-lists.md
  - https://docs.joinpopp.com/reference/list-candidate-notes-by-external-id.md
  - https://docs.joinpopp.com/reference/list-candidate-notes.md
  - https://docs.joinpopp.com/reference/list-conversation-documents.md
  - https://docs.joinpopp.com/reference/list-conversation-messages.md
  - https://docs.joinpopp.com/reference/list-conversations.md
  - https://docs.joinpopp.com/reference/list-custom-fields.md
  - https://docs.joinpopp.com/reference/list-document-credentials.md
  - https://docs.joinpopp.com/reference/list-document-types.md
  - https://docs.joinpopp.com/reference/list-meeting-templates.md
  - https://docs.joinpopp.com/reference/list-organization-users.md
  - https://docs.joinpopp.com/reference/list-organizations.md
  - https://docs.joinpopp.com/reference/list-tags.md
  - https://docs.joinpopp.com/reference/list-templates.md
  - https://docs.joinpopp.com/reference/list-user-calendars.md
  - https://docs.joinpopp.com/reference/list-users.md
  - https://docs.joinpopp.com/reference/list-webhook-events.md
  - https://docs.joinpopp.com/reference/list-webhooks.md
  - https://docs.joinpopp.com/reference/list-workflow-analysis-application-history.md
  - https://docs.joinpopp.com/reference/list-workflow-analysis-applications.md
  - https://docs.joinpopp.com/reference/list-workflow-runs.md
  - https://docs.joinpopp.com/reference/list-workflows.md
  - https://docs.joinpopp.com/reference/parse-availability.md
  - https://docs.joinpopp.com/reference/pause-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/pause-workflow.md
  - https://docs.joinpopp.com/reference/process-document.md
  - https://docs.joinpopp.com/reference/publish-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/publish-workflow.md
  - https://docs.joinpopp.com/reference/reactivate-user-by-email.md
  - https://docs.joinpopp.com/reference/reactivate-user.md
  - https://docs.joinpopp.com/reference/remove-candidate-document-by-external-id.md
  - https://docs.joinpopp.com/reference/remove-candidate-document.md
  - https://docs.joinpopp.com/reference/remove-candidates-from-list-by-external-id.md
  - https://docs.joinpopp.com/reference/remove-candidates-from-list.md
  - https://docs.joinpopp.com/reference/reparse-candidate-cv-by-external-id.md
  - https://docs.joinpopp.com/reference/reparse-candidate-cv.md
  - https://docs.joinpopp.com/reference/resend-booking-url.md
  - https://docs.joinpopp.com/reference/resume-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/resume-workflow.md
  - https://docs.joinpopp.com/reference/send-conversation-message.md
  - https://docs.joinpopp.com/reference/set-user-calendar-availability.md
  - https://docs.joinpopp.com/reference/sign-out-user-by-email.md
  - https://docs.joinpopp.com/reference/sign-out-user.md
  - https://docs.joinpopp.com/reference/start-workflow-runs-by-external-id.md
  - https://docs.joinpopp.com/reference/start-workflow-runs.md
  - https://docs.joinpopp.com/reference/stop-campaign.md
  - https://docs.joinpopp.com/reference/takeover-conversation.md
  - https://docs.joinpopp.com/reference/update-analysis.md
  - https://docs.joinpopp.com/reference/update-booking.md
  - https://docs.joinpopp.com/reference/update-campaign.md
  - https://docs.joinpopp.com/reference/update-candidate-by-external-id.md
  - https://docs.joinpopp.com/reference/update-candidate-list-by-external-id.md
  - https://docs.joinpopp.com/reference/update-candidate-list.md
  - https://docs.joinpopp.com/reference/update-candidate-note.md
  - https://docs.joinpopp.com/reference/update-candidate.md
  - https://docs.joinpopp.com/reference/update-custom-field.md
  - https://docs.joinpopp.com/reference/update-document-credential.md
  - https://docs.joinpopp.com/reference/update-document-type.md
  - https://docs.joinpopp.com/reference/update-meeting-template.md
  - https://docs.joinpopp.com/reference/update-organization-config-by-external-id.md
  - https://docs.joinpopp.com/reference/update-organization-config.md
  - https://docs.joinpopp.com/reference/update-organization-details.md
  - https://docs.joinpopp.com/reference/update-requirements-and-reanalyse.md
  - https://docs.joinpopp.com/reference/update-user-by-email.md
  - https://docs.joinpopp.com/reference/update-user.md
  - https://docs.joinpopp.com/reference/update-webhook.md
  - https://docs.joinpopp.com/reference/update-workflow-by-external-id.md
  - https://docs.joinpopp.com/reference/update-workflow.md
  merge:
    pages: 149
    deduped: 618
    conflicts_kept_first: 0