Get all contractor forms

get https://api.gusto-demo.com/v1/contractors/{contractor_uuid}/forms

Get a list of all contractor's forms

scope: contractor_forms:read

Responses

Response body

array of objects

object

uuid

string

required

The UUID of the form

name

string

The type identifier of the form

title

string

The title of the form

description

string

The description of the form

draft

boolean

If the form is in a draft state. E.g. End of year tax forms may be provided in a draft state prior to being finalized.

year

integer | null

The year of this form. For some forms, e.g. tax forms, this is the year which the form represents. A 1099 for January - December 2022 would be delivered in January 2023 and have a year value of 2022. This value is nullable and will not be present on all forms.

quarter

integer | null

The quarter of this form. This value is currently always null since it is not present on any contractor forms.

requires_signing

boolean

A boolean flag that indicates whether the form needs signing or not. Note that this value will change after the form is signed.

document_content_type

string | null

The content type of the associated document. Most forms are PDFs with a content type of application/pdf. Some tax file packages will be zip files (containing PDFs) with a content type of application/zip. This attribute will be null when the document has not been prepared.

contractor_uuid

string

The contractor UUID

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.gusto-demo.com/v1/contractors/contractor_uuid/forms \
3
     --header 'X-Gusto-API-Version: 2024-04-01' \
4
     --header 'accept: application/json'


xxxxxxxxxx
14
 
1
[
2
  {
3
    "uuid": "48cdd5ec-a4dd-4840-a424-ad79f38d8408",
4
    "name": "US_1099",
5
    "title": "Form 1099: 2020",
6
    "description": "Form 1099 records your annual income as a contractor.",
7
    "draft": false,
8
    "requires_signing": false,
9
    "year": 2020,
10
    "quarter": null,
11
    "document_content_type": "application/pdf",
12
    "contractor_uuid": "123dd616-6dbc-4724-938a-403f6217a933"
13
  }
14
]

200Example response