> ## Documentation Index > Fetch the complete documentation index at: https://docs.sterndesk.com/llms.txt > Use this file to discover all available pages before exploring further. # ListCrewRequests > RPC to get the list of crew requests ## OpenAPI ````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/ListCrewRequests openapi: 3.1.0 info: title: Sterndesk API version: 1.0.0 description: > HTTP/JSON access to the Sterndesk data available to your account. Every Sterndesk operation is a Connect RPC: send `POST ` with a JSON body and the `Connect-Protocol-Version: 1` header. Authenticate with a personal API key (Settings → My account → API keys) using `Authorization: Bearer `. A key reads everything documented here. The one write operation is uploading candidate documents, which needs a key carrying the `sterndesk:documents:write` permission; permissions are chosen when the key is created and are never added to an existing key. Every other write operation is rejected. ## Uploading candidate documents An upload is a batch of documents, the same batch a recruiter hands to Sterndesk from the dashboard. It may hold the documents of one candidate or of several people: Sterndesk groups them by identity and creates one candidate per person. Sending them takes two calls. 1. `POST /rpc/rpc.v1.OrganizationService/CreateManualUpload` creates the upload and returns a signed, time-limited instruction: `upload_url`, `params`, `signature` and `expires_at`, together with the limits the upload must satisfy. 2. `POST /assemblies` sends the files to Transloadit, the upload processor, as `multipart/form-data`, with `params` and `signature` as form fields. Send both verbatim: the signature covers those exact bytes, so pretty-printing `params`, reordering its keys, or parsing and re-encoding it invalidates the signature. The files go straight to Transloadit and never pass through Sterndesk. Processing then continues asynchronously, exactly as it does for a dashboard upload. `POST /rpc/rpc.v1.OrganizationService/ListManualUploads` reports the progress of the upload created in step 1. servers: - url: https://edge.sterndesk.com security: - apiKey: [] tags: - name: rpc.v1.OrganizationService description: Organization service RPC for organization method. - name: rpc.v1.RootService description: RootService provides top-level RPCs. paths: /rpc/rpc.v1.OrganizationService/ListCrewRequests: post: tags: - rpc.v1.OrganizationService summary: ListCrewRequests description: RPC to get the list of crew requests operationId: rpc.v1.OrganizationService.ListCrewRequests parameters: - name: Connect-Protocol-Version in: header description: Define the version of the Connect protocol required: true schema: $ref: '#/components/schemas/connect-protocol-version' example: 1 - name: Connect-Timeout-Ms in: header description: Define the timeout, in ms schema: $ref: '#/components/schemas/connect-timeout-header' example: 1000 requestBody: content: application/json: schema: $ref: '#/components/schemas/rpc.v1.ListCrewRequestsRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/rpc.v1.ListCrewRequestsResponse' default: description: Error content: application/json: schema: $ref: '#/components/schemas/connect.error' components: schemas: connect-protocol-version: type: number examples: - 1 title: Connect-Protocol-Version description: Define the version of the Connect protocol const: 1 connect-timeout-header: type: number examples: - 1000 title: Connect-Timeout-Ms description: Define the timeout, in ms rpc.v1.ListCrewRequestsRequest: type: object properties: organizationId: type: string title: organization_id format: uuid description: id of the organisation filterByAssigneeIds: type: array items: type: string format: uuid title: filter_by_assignee_ids description: assignee member ids to filter the list of crew requests filterByLocations: type: array items: type: string title: filter_by_locations description: locations to filter the list of crew requests filterByAuthorIds: type: array items: type: string format: uuid title: filter_by_author_ids description: author ids to filter the list of crew requests createdAtFrom: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at_from description: Timestamp 'from a time' when a crew request was created createdAtTo: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at_to description: Timestamp 'until a time' when a crew request was created title: ListCrewRequestsRequest additionalProperties: false description: Request for getting the List of crew requests rpc.v1.ListCrewRequestsResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/rpc.v1.OneCrewRequestResponse' title: items description: items of crew request title: ListCrewRequestsResponse additionalProperties: false description: Response for getting the List of crew requests connect.error: type: object properties: code: type: string examples: - not_found enum: - canceled - unknown - invalid_argument - deadline_exceeded - not_found - already_exists - permission_denied - resource_exhausted - failed_precondition - aborted - out_of_range - unimplemented - internal - unavailable - data_loss - unauthenticated description: >- The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code]. message: type: string description: >- A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client. details: type: array items: $ref: '#/components/schemas/connect.error_details.Any' description: >- A list of messages that carry the error details. There is no limit on the number of messages. title: Connect Error additionalProperties: true description: >- Error type returned by Connect: https://connectrpc.com/docs/go/errors/#http-representation google.protobuf.Timestamp: type: string examples: - '2023-01-15T01:30:15.01Z' - '2024-12-25T12:00:00Z' format: date-time description: >- A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. rpc.v1.OneCrewRequestResponse: type: object properties: id: type: string title: id format: uuid description: id of the crew request organizationId: type: string title: organization_id format: uuid description: id of the organisation description: allOf: - $ref: '#/components/schemas/google.protobuf.Struct' title: description description: description of the crew request title: type: string title: title description: title of the crew request createdAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: Timestamp when the crew request was created updatedAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at description: Timestamp when the crew request was updated positions: type: array items: $ref: '#/components/schemas/rpc.v1.OneCrewRequestResponse.PositionItem' title: positions description: list of crew request positions amountAllPositions: type: string title: amount_all_positions format: int64 description: amount of all number of positions in crew requests assignedMembers: type: array items: $ref: '#/components/schemas/rpc.v1.OneCrewRequestResponse.AssignedMember' title: assigned_members description: list of document request items author: allOf: - $ref: '#/components/schemas/rpc.v1.OneCrewRequestResponse.Author' title: author description: member who created the crew request state: allOf: - $ref: '#/components/schemas/rpc.v1.JobPostingState' title: state description: state of the crew request locationIso31661: type: - string - 'null' title: location_iso3166_1 description: location value title: OneCrewRequestResponse additionalProperties: false description: Response for getting a one crew request connect.error_details.Any: type: object properties: type: type: string description: >- A URL that acts as a globally unique identifier for the type of the serialized message. For example: `type.googleapis.com/google.rpc.ErrorInfo`. value: type: string format: binary description: >- The Protobuf message, serialized as bytes and base64-encoded. The specific message type is identified by the `type` field. debug: type: object title: Debug additionalProperties: true description: >- Deserialized error detail payload. The 'type' field indicates the schema. This field is for easier debugging and should not be relied upon for application logic. additionalProperties: true description: >- Contains an arbitrary serialized message along with a @type that describes the type of the serialized message, with an additional debug field for ConnectRPC error details. google.protobuf.Struct: type: object additionalProperties: $ref: '#/components/schemas/google.protobuf.Value' description: A JSON object whose property values may be any JSON value. rpc.v1.OneCrewRequestResponse.PositionItem: type: object properties: id: type: string title: id format: uuid description: id of the crew request position title: type: string title: title description: title of the position value: type: string title: value description: value of the position (have to use rank value) nbPositions: type: string title: nb_positions format: int64 description: amount of positions linkedJobPosting: oneOf: - $ref: >- #/components/schemas/rpc.v1.OneCrewRequestResponse.PositionItem.LinkedJobPosting - type: 'null' title: linked_job_posting description: a job posting links to crew request position listPipelineStages: type: array items: $ref: >- #/components/schemas/rpc.v1.OneCrewRequestResponse.PositionItem.PipelineStage title: list_pipeline_stages description: a list of pipeline stages linked to a crew request title: PositionItem additionalProperties: false description: item of position rpc.v1.OneCrewRequestResponse.AssignedMember: type: object properties: id: type: string title: id format: uuid description: id of the assigned member to the crew request givenName: type: - string - 'null' title: given_name description: given name of the assigned member to the crew request familyName: type: - string - 'null' title: family_name description: family name of the assigned member to the crew request avatarUrl: type: - string - 'null' title: avatar_url description: avatar url of the assigned member to the crew request primaryEmail: type: string title: primary_email description: primary email of the assigned member to the crew request title: AssignedMember additionalProperties: false description: item of assigned member rpc.v1.OneCrewRequestResponse.Author: type: object properties: id: type: string title: id format: uuid description: id of the member who created the crew request givenName: type: - string - 'null' title: given_name description: given name of the member who created the crew request familyName: type: - string - 'null' title: family_name description: family name of the member who created the crew request avatarUrl: type: - string - 'null' title: avatar_url description: avatar url of the member who created the crew request title: Author additionalProperties: false description: author message rpc.v1.JobPostingState: type: string title: JobPostingState enum: - JOB_POSTING_STATE_UNSPECIFIED - JOB_POSTING_STATE_OPEN - JOB_POSTING_STATE_CLOSED description: state of a job posting google.protobuf.Value: oneOf: - type: 'null' - type: number - type: string - type: boolean - type: array - type: object additionalProperties: true description: 'Any JSON value: `null`, number, string, boolean, array, or object.' rpc.v1.OneCrewRequestResponse.PositionItem.LinkedJobPosting: type: object properties: id: type: string title: id format: uuid description: id of the linked job posting title: type: string title: title description: a title of the linked job posting state: allOf: - $ref: '#/components/schemas/rpc.v1.JobPostingState' title: state description: state of the linked job posting assignedMembers: type: array items: $ref: '#/components/schemas/rpc.v1.OneCrewRequestResponse.AssignedMember' title: assigned_members description: list of assigned members title: LinkedJobPosting additionalProperties: false description: item of job posting which linked with a crew request rpc.v1.OneCrewRequestResponse.PositionItem.PipelineStage: type: object properties: stageId: type: string title: stage_id format: uuid description: ID of the stage name: type: string title: name maxLength: 128 minLength: 1 description: Name of the pipeline stage position: type: string title: position format: int64 description: Position of the stage within the pipeline colorRed: type: integer title: color_red maximum: 255 minimum: 0 format: int32 description: RGB color components for the stage colorGreen: type: integer title: color_green maximum: 255 minimum: 0 format: int32 description: green color colorBlue: type: integer title: color_blue maximum: 255 minimum: 0 format: int32 description: blue color isUnreviewed: type: boolean title: is_unreviewed description: Flags indicating the stage type isAccepted: type: boolean title: is_accepted description: whether its an "accepted" stage isRejected: type: boolean title: is_rejected description: whether its an "rejected" stage nbApplications: type: string title: nb_applications format: int64 description: amount of applications candidateStatus: allOf: - $ref: '#/components/schemas/rpc.v1.PipelineStageCandidateStatus' title: candidate_status description: what happens to candidates in this stage title: PipelineStage additionalProperties: false description: item of a pipeline stage rpc.v1.PipelineStageCandidateStatus: type: string title: PipelineStageCandidateStatus enum: - PIPELINE_STAGE_CANDIDATE_STATUS_UNSPECIFIED - PIPELINE_STAGE_CANDIDATE_STATUS_IN_PROGRESS - PIPELINE_STAGE_CANDIDATE_STATUS_COMPLETED - PIPELINE_STAGE_CANDIDATE_STATUS_REJECTED description: >- What happens to a candidate that enters a pipeline stage. Independent of the stage order and of the flags that mark the system stages, so any number of stages can be rejections. securitySchemes: apiKey: type: http scheme: bearer description: 'Personal API key, sent as `Authorization: Bearer `.' ````