v1

latestOpenAPI 3.0.02026-08-061280285.2 KB
Placement APIs

Lists all placements in the account.

get/api/external/placement-record/list

Query parameters

items_per_pagestring
current_pagestring
detailedstring
user_idstring
include_countstring

Count of total records

Headers

RF-Api-Keystring
content-typestring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/placement-record/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"bill_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"billing_date":null,"bonus":{"currency":"USD","number":null},"contacts":[{"email":null,"id":32,"img_link":null,"label":"jhcbvjh","name":"jhcbvjh","type":2,"value":32}],"contract_end_date":null,"contract_start_date":null,"id":418,"job":{"client_company":{"id":30860,"name":"Test company Varun"},"id":17114,"job_type":{"id":4,"name":"Temporary"},"job_visibility_id":6,"name":"ts test job"},"job_start_date":"2023-02-13","note":"","pay_rate":{"currency":"USD","frequency":{"display_name":"hr","id":1,"name":"hour"},"number":56546},"prospect":{"id":30,"name":"yghj"},"retainer":{"currency":"USD","frequency":{"display_name":"net","id":1,"name":"net"},"number":4677576},"revenue":{"currency":"USD","number":0},"revenue_split":[{"revenue":{"number":0,"pct":12},"user":{"id":1}}],"salary":{"currency":"USD","number":null},"success_fee":{"currency":"USD","number":null},"user":{"id":102035},"version":{"id":420},"work_quantum":{"frequency":{"display_name":"week","id":2,"name":"week"},"is_full_time":false,"number":1,"unit":{"display_name":"days","id":2,"name":"day"}}}],"total_items":1}}

Example response

{
  "data": [
    {
      "bill_rate": {
        "currency": "USD",
        "frequency": {
          "display_name": "hr",
          "id": 1,
          "name": "hour"
        },
        "number": 56546
      },
      "billing_date": null,
      "bonus": {
        "currency": "USD",
        "number": null
      },
      "contacts": [
        {
          "email": null,
          "id": 32,
          "img_link": null,
          "label": "jhcbvjh",
          "name": "jhcbvjh",
          "type": 2,
          "value": 32
        }
      ],
      "contract_end_date": null,
      "contract_start_date": null,
      "id": 418,
      "job": {
        "client_company": {
          "id": 30860,
          "name": "Test company Varun"
        },
        "id": 17114,
        "job_type": {
          "id": 4,
          "name": "Temporary"
        },
        "job_visibility_id": 6,
        "name": "ts test job"
      },
      "job_start_date": "2023-02-13",
      "note": "",
      "pay_rate": {
        "currency": "USD",
        "frequency": {
          "display_name": "hr",
          "id": 1,
          "name": "hour"
        },
        "number": 56546
      },
      "prospect": {
        "id": 30,
        "name": "yghj"
      },
      "retainer": {
        "currency": "USD",
        "frequency": {
          "display_name": "net",
          "id": 1,
          "name": "net"
        },
        "number": 4677576
      },
      "revenue": {
        "currency": "USD",
        "number": 0
      },
      "revenue_split": [
        {
          "revenue": {
            "number": 0,
            "pct": 12
          },
          "user": {
            "id": 1
          }
        }
      ],
      "salary": {
        "currency": "USD",
        "number": null
      },
      "success_fee": {
        "currency": "USD",
        "number": null
      },
      "user": {
        "id": 102035
      },
      "version": {
        "id": 420
      },
      "work_quantum": {
        "frequency": {
          "display_name": "week",
          "id": 2,
          "name": "week"
        },
        "is_full_time": false,
        "number": 1,
        "unit": {
          "display_name": "days",
          "id": 2,
          "name": "day"
        }
      }
    }
  ],
  "total_items": 1
}