About Gigs - Docs

What are gigs?

Gigs represent opportunities for work. A Gig has a start and end date during which workers can perform tasks. Cirro can - and by default will automatically - invite workers for Gigs in waves, until the gig is full or the end date is reached.

Related guide: Gigs & Invitations

Endpoints

POST https://api.cirro.io/v2/gigs POST https://api.cirro.io/v2/gigs/:id GET https://api.cirro.io/v2/gigs/:id POST https://api.cirro.io/v2/gigs/:id/invite POST https://api.cirro.io/v2/gigs/:id/archive DELETE https://api.cirro.io/v2/gigs/:id POST https://api.cirro.io/v2/gigs/:id/tasks POST https://api.cirro.io/v2/gigs/:gig_id/tasks/:id

The gig object

Attributes

Attribute	Type	Description
`id`	`string`	The unique identifier of the gig.
`object`	`string`	Always "gig"
`title`	`string`	The title of the gig.
`description`	`string`	The description of the gig.
`url`	`string`	The URL of the gig in the Space.
`start_at`	`number`	The start date/time as a UNIX timestamp.
`end_at`	`number`	The end date/time as a UNIX timestamp.
`archive_at`	`number`	The date/time at which this Gig should be automatically archived, as a UNIX timestamp.
`archived_at`	`number`	The archival date/time as a UNIX timestamp.
`total_seats`	`number`	The total number of seats for the gig.
`seats_min`	`number`	The minimum number of seats for the gig. This value controls the invitation wave, when the number of accepted gig invitations is above it, invitation wave will stop. Otherwise it will start auto inviting again.
`seats_max`	`number`	The maximum number of seats for the gig. When this value is set and the amount of accepted gig invitations reaches this value Cirro will automatically expire all remaining pending gig invitations.
`invitation_mode`	`enum`	The invitation mode of the gig. Possible values are: `auto` and `manual`.
`invitation_multiplier`	`number`	The invitation multiplier of the gig. Used to calculate the number of invitations sent out per wave: total seats x multiplier
`invitation_frequency`	`number`	The invitation wave frequency in minutes for this Gig. Default: 5
`filter_query`	`object`	The filter query object for finding matching Workers (MQL)
`sort_query`	`object`	The sorting query object for defining the sort order with which matching Workers are invited (MQL)
`notification_payload`	`object`	key value pairs to be used in invitation email templates
`invitation_notification_topic`	`object`	The notification topic used for gig invitation. by default Cirro triggers new_gig_invitation notification for auto invites, you can overwrite it with a different topic with id or name
`tasks`	`object`	A list object containing tasks available in this Gig and their respective payout base price.
`epam_options`	`object`	EPAM specific options for controlling certain EPAM-internal processes. If you don't know what this means, you can and should ignore it.

Example

{
  "id": "5115b65b-d1da-4f73-a8e7-1cc914fac181",
  "object": "gig",
  "title": "Tree planting event",
  "description": "Description of gig ...",
  "url": "https://plant-a-tree.com/events/1234",
  "start_at": 1652285764,
  "end_at": 1653412329,
  "archived_at": null,
  "total_seats": 2,
  "seats_min": 2,
  "seats_max": null,
  "invitation_mode": "auto",
  "invitation_multiplier": 10,
  "invitation_frequency": 5,
  "filter_query": {
      "status": "active",
      "segment": "my_favorite_testers"
  },
  "tasks": {
      "object": "list",
      "data": [
          {
              "id": "1",
              "object": "gig_task"
              "title": "Ah, Wilderness!",
              "base_price": 300
          }
      ]
  },
  "notification_payload": {
      "project_title": "Corporate Tax",
      "task_title": "Add dataset",
      "task_type": "Review"
  },
  "invitation_notification_topic": {
      "id": "2",
      "object": "notification_topic",
      "name": "new_gig_invitation"
  },
  "epam_options": {
      "extra_mile": true
  }
}