> ## 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. # ListCrewProfilesByProposalID > List crew profile candidates assigned to a proposal ## OpenAPI ````yaml https://edge.test.sterndesk.com/api/openapi.yaml post /rpc/rpc.v1.OrganizationService/ListCrewProfilesByProposalID 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/ListCrewProfilesByProposalID: post: tags: - rpc.v1.OrganizationService summary: ListCrewProfilesByProposalID description: List crew profile candidates assigned to a proposal operationId: rpc.v1.OrganizationService.ListCrewProfilesByProposalID 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.ListCrewProfilesByProposalIDRequest' required: true responses: '200': description: Success content: application/json: schema: $ref: >- #/components/schemas/rpc.v1.ListCrewProfilesByProposalIDResponse 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.ListCrewProfilesByProposalIDRequest: type: object properties: proposalId: type: string title: proposal_id format: uuid description: id of the proposal page: type: - string - 'null' title: page minimum: 1 format: int64 description: >- page of results to return, one-based. defaults to the first page when not set perPage: type: - string - 'null' title: per_page maximum: 200 minimum: 1 format: int64 description: nr of items per page, defaults to 20 when not set title: ListCrewProfilesByProposalIDRequest additionalProperties: false description: request to list crew profile candidates for a proposal rpc.v1.ListCrewProfilesByProposalIDResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/rpc.v1.ProposalCrewProfile' title: items description: enriched candidate assignments ordered by created_at ASC totalFound: type: string title: total_found format: int64 description: total number of candidates on the proposal totalPages: type: string title: total_pages format: int64 description: total number of pages for all results currentPage: type: string title: current_page format: int64 description: current page in the results title: ListCrewProfilesByProposalIDResponse additionalProperties: false description: response containing crew profile candidates for a proposal 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 rpc.v1.ProposalCrewProfile: type: object properties: id: type: string title: id description: id of the assignment record proposalId: type: string title: proposal_id description: id of the proposal crewProfileId: type: string title: crew_profile_id description: id of the crew profile status: allOf: - $ref: '#/components/schemas/rpc.v1.ProposalCrewStatus' title: status description: current candidate status createdAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: created_at description: timestamp when the assignment was created updatedAt: allOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' title: updated_at description: timestamp when the assignment was last updated givenName: type: - string - 'null' title: given_name description: given name of the crew profile (absent if not set) familyName: type: - string - 'null' title: family_name description: family name of the crew profile (absent if not set) nationality: type: - string - 'null' title: nationality description: ISO 3166-1 nationality code (absent if not extracted) rank: type: - string - 'null' title: rank description: most recent at-sea rank (absent if not extracted) careerStartedAt: oneOf: - $ref: '#/components/schemas/google.protobuf.Timestamp' - type: 'null' title: career_started_at description: >- start of career derived from the earliest at-sea contract (absent if none extracted) vesselTypes: type: array items: type: string title: vessel_types description: distinct vessel types across all at-sea contracts documentCount: type: string title: document_count format: int64 description: >- nr of documents in the set named by document_set_id, 0 when there is no such set documentSetId: type: - string - 'null' title: document_set_id description: >- id of the most recent document set for this crew profile (absent if none) faceImageUrl: type: - string - 'null' title: face_image_url description: >- pre-signed url of the most recent extracted face image (absent if none was extracted) primaryEmail: type: - string - 'null' title: primary_email description: >- primary email of the crew profile. omitted for unauthenticated career-site callers emailFrom: allOf: - $ref: '#/components/schemas/rpc.v1.CrewProfileEmailSource' title: email_from description: >- how primary_email was determined. only meaningful when primary_email is set title: ProposalCrewProfile additionalProperties: false description: >- a crew profile candidate assigned to a proposal, enriched with crew profile summary data 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. rpc.v1.ProposalCrewStatus: type: string title: ProposalCrewStatus enum: - PROPOSAL_CREW_STATUS_UNSPECIFIED - PROPOSAL_CREW_STATUS_PENDING - PROPOSAL_CREW_STATUS_INTERESTED - PROPOSAL_CREW_STATUS_NOT_INTERESTED description: status of a crew profile candidate within a proposal 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.CrewProfileEmailSource: type: string title: CrewProfileEmailSource enum: - CREW_PROFILE_EMAIL_SOURCE_UNSPECIFIED - CREW_PROFILE_EMAIL_SOURCE_FROM_DOCUMENTS - CREW_PROFILE_EMAIL_SOURCE_FROM_LATEST_APPLICATION - CREW_PROFILE_EMAIL_SOURCE_PLACEHOLDER description: >- CrewProfileEmailSource indicates how primary_email was determined for a crew profile. securitySchemes: apiKey: type: http scheme: bearer description: 'Personal API key, sent as `Authorization: Bearer `.' ````