client.jobs.list_projects

A method of the Jobs endpoint.

list_projects(id: int, *, hidden: bool = None) → ListResponse

List the projects a Job belongs to

API URL: GET /jobs/{id}/projects

import civis
client = civis.APIClient()
response = client.jobs.list_projects(...)

Parameters:

idint

The ID of the Job.

hiddenbool, optional

If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

Returns:

civis.ListResponse

• idint

  The ID for this project.

• authorcivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• namestr

  The name of this project.

• descriptionstr

  A description of the project.

• usersList[civis.Response]

  Users who can see the project.

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.

• auto_share : bool

• created_at : str (time)

• updated_at : str (time)

• archivedbool

  The archival status of the requested item(s).