Skip to main content
POST
/
api
/
v1
/
users
/
{user_id}
/
employments
Create an employment for a user
curl --request POST \
  --url https://api.scholarlysoftware.com/api/v1/users/{user_id}/employments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "employment",
    "attributes": {
      "effective_from": "2024-01-01",
      "title": "Faculty Assistant",
      "effective_to": "2023-12-25"
    },
    "relationships": {
      "user": {
        "data": {
          "type": "user",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "profile": {
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "employment",
    "attributes": {
      "effective_from": "2024-01-01",
      "custom_fields": {},
      "title": "Faculty Assistant",
      "effective_to": "2023-12-25"
    },
    "relationships": {
      "user": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "user",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      },
      "profile": {
        "links": {
          "related": "<string>"
        },
        "meta": {},
        "data": {
          "type": "profile",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Authorization
string
required

Bearer token

Path Parameters

​
user_id
string
required

User UUID

Body

application/vnd.api+json
​
data
object
required

Response

employment created

​
data
object
required