SEDNA Job Reference API API
The Job Reference API API from SEDNA — 7 operation(s) for job reference api.
The Job Reference API API from SEDNA — 7 operation(s) for job reference api.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/sedna-job-reference-api-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
contact:
name: Support
url: https://support.sedna.com
termsOfService: https://www.sedna.com/terms-of-service
title: Sedna Authentication Job Reference API
version: '2019-01-01'
servers:
- description: Platform endpoint
url: https://{tenant}.sednanetwork.com/platform
variables:
tenant:
default: example
description: Your tenant's unique identifier
security:
- Basic: []
- OAuth: []
tags:
- name: Job Reference API
paths:
/2019-01-01/job-reference:
post:
description: 'Create a job reference
Required API Permissions: JOBREFERENCE_WRITE'
operationId: createJobReference
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceCreate'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceCreate'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceSingle'
description: default response
tags:
- Job Reference API
get:
description: 'Fetch a collection of job references
Required API Permissions: JOBREFERENCE_READ'
operationId: getJobReferences
parameters:
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 100
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
- in: query
name: filter[foreignKey]
schema:
type: string
- in: query
name: filter[type]
schema:
type: string
- in: query
name: filter[source]
schema:
type: string
- in: query
name: filter[name]
schema:
type: string
- in: query
name: filter[ids]
schema:
type: string
- in: query
name: filter[jobReferenceIds]
schema:
type: string
- in: query
name: filter[createdAt][since]
schema:
type: string
- in: query
name: filter[createdAt][until]
schema:
type: string
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceCollection'
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}:
delete:
description: 'Delete a job reference
Required API Permissions: JOBREFERENCE_DELETE'
operationId: deleteJobReference
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- Job Reference API
get:
description: 'Fetch a job reference
Required API Permissions: JOBREFERENCE_READ'
operationId: getJobReference
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceSingle'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceSingle'
description: default response
tags:
- Job Reference API
patch:
description: 'Update a job reference
Required API Permissions: JOBREFERENCE_WRITE'
operationId: updateJobReference
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceUpdate'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceUpdate'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}/message:
get:
description: 'Fetches a collection of messages that have the given job reference applied. DEPRECATED: please use /{id}/messageV2 instead.
Required API Permissions: JOBREFERENCE_READ, MESSAGE_READ'
operationId: getMessagesWithJobReference
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 100
maximum: 100
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
- description: 'Comma separated list of fields to return. Please include only necessary fields for performance reasons. If this parameter is omitted, API will return all the fields and it can negatively impact the latency. Available fields: subject,snippet,fromName,fromEmail,bodyText,bodyHtml,hasAttachment,receivedAt,sentAt,messageId,inReplyTo,references,from,to,cc,bcc,signed. Id is always returned.'
in: query
name: fields[message]
schema:
type: string
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MessageCollection'
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}/messageV2:
get:
description: 'Fetch a collection of messages that have the given job reference applied
Required API Permissions: JOBREFERENCE_READ, MESSAGE_READ'
operationId: getMessagesWithJobReferenceV2
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- description: the next-page cursor returned as part of a previous call to this endpoint
in: query
name: page[cursor]
schema:
type: string
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 100
maximum: 100
- description: 'Comma separated list of fields to return. Please include only necessary fields for performance reasons. If this parameter is omitted, API will return all the fields and it can negatively impact the latency. Available fields: subject,snippet,fromName,fromEmail,bodyText,bodyHtml,hasAttachment,receivedAt,sentAt,messageId,inReplyTo,references,from,to,cc,bcc,signed. Id is always returned.'
in: query
name: fields[message]
schema:
type: string
- in: query
name: filter
schema:
type: string
- description: Comma separated list of teams to filter by. Only returns messages that belong to any of the specified teams. If omitted, messages belonging to all teams, including solo inboxes, are returned.
in: query
name: filter[team]
schema:
type: string
- description: The value to sort the message by. Must be one of 'received_date' or 'activity'. Defaults to 'received_date' if not specified.
in: query
name: sort
schema:
type: string
default: received_date
- description: The order in which to sort the messages, i.e. 'desc' (newest messages first) or 'asc' (oldest messages first). Defaults to 'desc' if not specified.
in: query
name: order
schema:
type: string
default: desc
- description: Array of comma-separated relationships to retrieve entities for if they are present in the retrieved messages' relationships. e.g. 'comment,document,share,team,category,job_reference,assignment,keyword,address'
in: query
name: include
schema:
type: string
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/WithNextPageCursorMessageCollection'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/WithNextPageCursorMessageCollection'
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}/relationships/message:
post:
description: 'Add messages to a job reference''s message relationships
Required API Permissions: JOBREFERENCE_WRITE'
operationId: addJobReferenceToMessages
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 1000
maximum: 1000
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMessageRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateMessageRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MessageRelToMany'
description: default response
tags:
- Job Reference API
get:
description: 'Fetch a job reference''s message relationships. DEPRECATED: please use /{id}/messageV2 instead.
Required API Permissions: JOBREFERENCE_READ, MESSAGE_READ'
operationId: getJobReferenceMessageRelationships
parameters:
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 100
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageRelGetToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MessageRelGetToMany'
description: default response
tags:
- Job Reference API
delete:
description: 'Delete messages from a job reference''s message relationships
Required API Permissions: JOBREFERENCE_WRITE'
operationId: removeJobReferenceFromMessages
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: page[limit]
schema:
type: integer
format: int64
default: 1000
maximum: 1000
- in: query
name: page[offset]
schema:
type: integer
format: int64
default: 0
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateMessageRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateMessageRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/MessageRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/MessageRelToMany'
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}/relationships/team:
post:
description: 'Add teams to a job reference''s team relationships
Required API Permissions: JOBREFERENCE_WRITE'
operationId: addJobReferenceTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- Job Reference API
delete:
description: 'Remove teams from a job reference''s team relationships
Required API Permissions: JOBREFERENCE_WRITE'
operationId: deleteJobReferenceTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- Job Reference API
get:
description: 'Fetch a job reference''s team relationships
Required API Permissions: JOBREFERENCE_READ'
operationId: getJobReferenceTeamRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- Job Reference API
patch:
description: 'Replace teams in a job reference''s team relationships
Required API Permissions: JOBREFERENCE_WRITE'
operationId: replaceJobReferenceTeams
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UpdateTeamRelToMany'
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/TeamRelToMany'
description: default response
tags:
- Job Reference API
/2019-01-01/job-reference/{id}/relationships/user:
get:
description: 'Fetch a job reference''s user relationships
Required API Permissions: JOBREFERENCE_READ'
operationId: getJobReferenceUserRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
- in: query
name: filter[createdBy]
schema:
type: string
description: Allows filtering on who created this job-reference subscription
enum:
- api
- ui
- '{userId}'
example: api
responses:
default:
content:
application/json:
schema:
$ref: '#/components/schemas/UserRelToMany'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/UserRelToMany'
description: default response
tags:
- Job Reference API
delete:
description: 'Unsubscribe users from a job reference
Required API Permissions: JOBREFERENCE_WRITE'
operationId: removeJobReferenceUserRelationships
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/JobReferenceToManyUserRelationshipWriteRepresentation'
application/vnd.api+json:
schema:
$ref: '#/components/schemas/JobReferenceToManyUserRelationshipWriteRepresentation'
responses:
default:
content:
application/json: {}
application/vnd.api+json: {}
description: default response
tags:
- Job Reference API
components:
schemas:
JobReferenceCreateResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/JobReferenceCreateAttributes'
relationships:
$ref: '#/components/schemas/JobReferenceCreateRelationships'
type:
type: string
TeamRelLinks:
type: object
properties:
related:
type: string
self:
type: string
MessageCollectionLinks:
type: object
properties:
first:
type: string
next:
type: string
self:
type: string
JobReferenceSingle:
type: object
description: The resource
properties:
data:
$ref: '#/components/schemas/JobReferenceResource'
links:
$ref: '#/components/schemas/JobReferenceSingleLinks'
JobReferenceSingleLinks:
type: object
properties:
self:
type: string
MessageCollection:
type: object
description: The resource
properties:
data:
type: array
items:
$ref: '#/components/schemas/MessageReadResource'
included:
type: array
items:
type: object
links:
$ref: '#/components/schemas/MessageCollectionLinks'
meta:
$ref: '#/components/schemas/MessageCollectionMeta'
TeamRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TeamRelData'
links:
$ref: '#/components/schemas/TeamRelLinks'
JobReferenceCreate:
type: object
properties:
data:
$ref: '#/components/schemas/JobReferenceCreateResource'
MessageMeta:
type: object
properties:
download:
type: string
UpdateTeamRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/TeamRelData'
DocumentRelLinks:
type: object
properties:
related:
type: string
self:
type: string
JobReferenceRelLinks:
type: object
properties:
related:
type: string
self:
type: string
DocumentRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/DocumentRelData'
links:
$ref: '#/components/schemas/DocumentRelLinks'
TagName:
type: object
properties:
value:
type: string
MessageRelData:
type: object
properties:
id:
type: string
type:
type: string
ResourceObjectIdentifier:
type: object
properties:
id:
type: string
meta:
$ref: '#/components/schemas/MetaObject'
type:
type: string
UserRelationshipWriteData:
type: object
properties:
id:
type: string
meta:
$ref: '#/components/schemas/UserRelationshipMeta'
type:
type: string
CategoryTagRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/CategoryTagRelData'
links:
$ref: '#/components/schemas/CategoryTagRelLinks'
MessageReadAttributes:
type: object
properties:
bcc:
type: array
items:
type: string
bodyHtml:
type: string
bodyText:
type: string
cc:
type: array
items:
type: string
from:
type: array
items:
type: string
fromEmail:
type: string
fromName:
type: string
hasAttachment:
type: boolean
inReplyTo:
type: string
messageId:
type: string
quarantineStatus:
type: string
receivedAt:
type: string
format: date-time
references:
type: string
sentAt:
type: string
format: date-time
signed:
type: string
enum:
- UNVERIFIED
- UNSIGNED
- VERIFIED
- FAILED_VERIFICATION
snippet:
type: string
subject:
type: string
to:
type: array
items:
type: string
MessageCollectionMeta:
type: object
properties:
count:
type: integer
format: int32
MessageLinks:
type: object
properties:
self:
type: string
JobReferenceRelData:
type: object
properties:
id:
type: string
messageTag:
$ref: '#/components/schemas/MessageTag'
type:
type: string
WithNextPageCursorMessageCollection:
type: object
properties:
nextPageCursor:
type: string
response:
$ref: '#/components/schemas/MessageCollection'
Sender:
type: object
properties:
data:
$ref: '#/components/schemas/ResourceObjectIdentifier'
meta:
$ref: '#/components/schemas/MetaObject'
PrivateLabelRelLinks:
type: object
properties:
related:
type: string
self:
type: string
JobReferenceUpdateResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/JobReferenceUpdateAttributes'
type:
type: string
JobReferenceLinks:
type: object
properties:
self:
type: string
TagLabel:
type: object
properties:
value:
type: string
MessageRelationships:
type: object
properties:
category-tag:
$ref: '#/components/schemas/CategoryTagRelToMany'
document:
$ref: '#/components/schemas/DocumentRelToMany'
job-reference:
$ref: '#/components/schemas/JobReferenceRelToMany'
message_thread_summary:
$ref: '#/components/schemas/MessageThreadSummary'
private-label:
$ref: '#/components/schemas/PrivateLabelRelToMany'
sender:
$ref: '#/components/schemas/Sender'
team:
$ref: '#/components/schemas/TeamRelToMany'
UserRelationshipMeta:
type: object
properties:
default:
type: boolean
disableSend:
type: boolean
watched:
type: boolean
UserRelLinks:
type: object
properties:
related:
type: string
self:
type: string
MessageTag:
type: object
properties:
assignedToUserId:
type: string
createdAt:
type: string
format: date-time
eventId:
$ref: '#/components/schemas/EventId'
messageId:
type: string
messageTagId:
$ref: '#/components/schemas/MessageTagId'
removedAt:
type: string
format: date-time
removedByUserId:
type: string
tag:
$ref: '#/components/schemas/Tag'
tagId:
$ref: '#/components/schemas/TagId'
userId:
type: string
MessageRelLinks:
type: object
properties:
related:
type: string
self:
type: string
MessageTagId:
type: object
properties:
id:
type: integer
format: int64
JobReferenceCreateAttributes:
type: object
properties:
archived:
type: boolean
attributes:
type: object
additionalProperties:
type: string
date:
type: string
format: date-time
foreignKey:
type: string
name:
type: string
source:
type: string
type:
type: string
enum:
- voyage
- head_fixture
- spot_fixture
- other
- ''
required:
- name
TeamRelData:
type: object
properties:
id:
type: string
type:
type: string
JobReferenceCollection:
type: object
description: A collection of resources
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobReferenceResource'
links:
$ref: '#/components/schemas/JobReferenceCollectionLinks'
MessageRelGetData:
type: object
properties:
id:
type: string
type:
type: string
Company:
type: object
properties:
data:
$ref: '#/components/schemas/ResourceObjectIdentifier'
JobReferenceRelationships:
type: object
properties:
company:
$ref: '#/components/schemas/Company'
tag:
$ref: '#/components/schemas/Tag'
team:
$ref: '#/components/schemas/TeamRelToMany'
user:
$ref: '#/components/schemas/UserRelToMany'
JobReferenceRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/JobReferenceRelData'
links:
$ref: '#/components/schemas/JobReferenceRelLinks'
MessageReadResource:
type: object
properties:
attributes:
$ref: '#/components/schemas/MessageReadAttributes'
id:
type: string
links:
$ref: '#/components/schemas/MessageLinks'
meta:
$ref: '#/components/schemas/MessageMeta'
relationships:
$ref: '#/components/schemas/MessageRelationships'
type:
type: string
TagId:
type: object
properties:
id:
type: integer
format: int64
JobReferenceToManyUserRelationshipWriteRepresentation:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/UserRelationshipWriteData'
required:
- data
Tag:
type: object
properties:
id:
$ref: '#/components/schemas/TagId'
name:
$ref: '#/components/schemas/TagName'
tagLabel:
$ref: '#/components/schemas/TagLabel'
tagTypeId:
type: integer
format: int32
MessageRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/MessageRelData'
links:
$ref: '#/components/schemas/MessageRelLinks'
JobReferenceUpdate:
type: object
properties:
data:
$ref: '#/components/schemas/JobReferenceUpdateResource'
EventId:
type: object
properties:
id:
type: integer
format: int64
JobReferenceUpdateAttributes:
type: object
properties:
archived:
type: boolean
attributes:
type: object
additionalProperties:
type: string
date:
type: string
format: date-time
foreignKey:
type: string
name:
type: string
source:
type: string
type:
type: string
enum:
- voyage
- head_fixture
- spot_fixture
- other
- ''
required:
- name
JobReferenceCollectionLinks:
type: object
properties:
first:
type: string
next:
type: string
self:
type: string
UserRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/UserRelData'
links:
$ref: '#/components/schemas/UserRelLinks'
CategoryTagRelData:
type: object
properties:
id:
type: string
messageTag:
$ref: '#/components/schemas/MessageTag'
type:
type: string
UserRelData:
type: object
properties:
id:
type: string
type:
type: string
DocumentRelData:
type: object
properties:
id:
type: string
type:
type: string
PrivateLabelRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/PrivateLabelRelData'
links:
$ref: '#/components/schemas/PrivateLabelRelLinks'
MetaObject:
type: object
MessageRelUpdateData:
type: object
properties:
id:
type: string
type:
type: string
CategoryTagRelLinks:
type: object
properties:
related:
type: string
self:
type: string
JobReferenceCreateRelationships:
type: object
properties:
team:
$ref: '#/components/schemas/UpdateTeamRelToMany'
user:
$ref: '#/components/schemas/UserRelToMany'
JobReferenceAttributes:
type: object
properties:
archived:
type: boolean
attributes:
type: string
createdAt:
type: string
date:
type: string
foreignKey:
type: string
modifiedAt:
type: string
name:
type: string
source:
type: string
tagId:
type: string
type:
type: string
required:
- name
MessageRelGetToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/MessageRelGetData'
links:
$ref: '#/components/schemas/MessageRelLinks'
MessageThreadSummary:
type: object
properties:
data:
$ref: '#/components/schemas/ResourceObjectIdentifier'
PrivateLabelRelData:
type: object
properties:
id:
type: string
type:
type: string
UpdateMessageRelToMany:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/
# --- truncated at 32 KB (35 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sedna/refs/heads/main/openapi/sedna-job-reference-api-api-openapi.yml